var searchIndex = {};
searchIndex["gif"] = {"doc":"# GIF encoding and decoding library","items":[[3,"Frame","gif","A GIF frame",null,null],[12,"delay","","Frame delay.",0,null],[12,"dispose","","Disposal method.",0,null],[12,"transparent","","Transparent index (if available).",0,null],[12,"needs_user_input","","True if the frame needs user input do be displayed.",0,null],[12,"top","","Offset from the top border of the canvas.",0,null],[12,"left","","Offset from the left border of the canvas.",0,null],[12,"width","","Width of the frame.",0,null],[12,"height","","Height of the frame.",0,null],[12,"interlaced","","True if the image is interlaced.",0,null],[12,"palette","","Frame local color palette if available.",0,null],[12,"buffer","","Buffer containing the image data.\nOnly indices unless configured differently.",0,null],[3,"StreamingDecoder","","GIF decoder which supports streaming",null,null],[3,"MemoryLimit","","Memory limit in bytes. `MemoryLimit::Some(0)` means\nthat there is no memory limit set.",null,null],[12,"0","","",1,null],[3,"Reader","","GIF decoder",null,null],[3,"Decoder","","GIF decoder",null,null],[3,"Encoder","","GIF encoder.",null,null],[3,"Writer","","Wrapper for `Encoder` that indicates that the file headers have been written.",null,null],[4,"Block","","Known GIF block types",null,null],[13,"Image","","Image block.",2,null],[13,"Extension","","Extension block.",2,null],[13,"Trailer","","Image trailer.",2,null],[4,"Extension","","Known GIF extensions",null,null],[13,"Text","","Text extension.",3,null],[13,"Control","","Control extension.",3,null],[13,"Comment","","Comment extension.",3,null],[13,"Application","","Application extension.",3,null],[4,"DisposalMethod","","Disposal method",null,null],[13,"Any","","StreamingDecoder is not required to take any action.",4,null],[13,"Keep","","Do not dispose.",4,null],[13,"Background","","Restore to background color.",4,null],[13,"Previous","","Restore to previous.",4,null],[4,"Decoded","","Indicates whether a certain object has been decoded",null,null],[13,"Nothing","","Decoded nothing.",5,null],[13,"GlobalPalette","","Global palette.",5,null],[13,"BackgroundColor","","Index of the background color in the global palette.",5,null],[13,"Trailer","","Decoded the image trailer.",5,null],[13,"BlockStart","","The start of a block.",5,null],[13,"SubBlockFinished","","Decoded a sub-block. More sub-block are available.",5,null],[13,"BlockFinished","","Decoded the last (or only) sub-block of a block.",5,null],[13,"Frame","","Decoded all information of the next frame.\nThe returned frame does **not** any image data.",5,null],[13,"Data","","Decoded some data of the current frame.",5,null],[13,"DataEnd","","No more data available the current frame.",5,null],[4,"DecodingError","","Decoding error.",null,null],[13,"Format","","Returned if the image is found to be malformed.",6,null],[13,"Internal","","Internal (logic) error.",6,null],[13,"Io","","Wraps `std::io::Error`.",6,null],[4,"ColorOutput","","Output mode for the image data",null,null],[13,"RGBA","","The decoder expands the image data to 32bit RGBA.\nThis affects:",7,null],[13,"Indexed","","The decoder returns the raw indexed data.",7,null],[4,"Extensions","","Configures how extensions should be handled",null,null],[13,"Save","","Saves all extention data",8,null],[13,"Skip","","Skips the data of unknown extensions\nand extracts the data from known ones",8,null],[4,"ExtensionData","","Extension data.",null,null],[13,"Control","","Control extension",9,null],[12,"flags","gif::ExtensionData","Flags.",9,null],[12,"delay","","Frame delay.",9,null],[12,"trns","","Transparent index.",9,null],[11,"clone","gif","",4,null],[11,"fmt","","",4,null],[11,"from_u8","","Converts `u8` to `Option<Self>`",4,{"inputs":[{"name":"u8"}],"output":{"name":"option"}}],[11,"clone","","",2,null],[11,"fmt","","",2,null],[11,"from_u8","","Converts `u8` to `Option<Self>`",2,{"inputs":[{"name":"u8"}],"output":{"name":"option"}}],[11,"clone","","",3,null],[11,"fmt","","",3,null],[11,"from_u8","","Converts `u8` to `Option<Self>`",3,{"inputs":[{"name":"u8"}],"output":{"name":"option"}}],[11,"clone","","",0,null],[11,"fmt","","",0,null],[11,"default","","",0,{"inputs":[],"output":{"name":"frame"}}],[11,"from_rgba","","Creates a frame from pixels in RGBA format.",0,null],[11,"from_rgb","","Creates a frame from pixels in RGB format.",0,null],[11,"fmt","","",6,null],[11,"from","","",6,{"inputs":[{"name":"error"}],"output":{"name":"self"}}],[11,"fmt","","",8,null],[11,"eq","","",8,null],[11,"set_param","","",8,null],[11,"fmt","","",5,null],[11,"fmt","","",10,null],[11,"new","","Creates a new streaming decoder",10,{"inputs":[],"output":{"name":"streamingdecoder"}}],[11,"update","","Updates the internal state of the decoder.",10,null],[11,"last_ext","","Returns the data of the last extension that has been decoded.",10,null],[11,"current_frame_mut","","Current frame info as a mutable ref.",10,null],[11,"current_frame","","Current frame info as a ref.",10,null],[11,"width","","Width of the image",10,null],[11,"height","","Height of the image",10,null],[11,"fmt","","",7,null],[11,"eq","","",7,null],[11,"set_param","","",7,null],[11,"fmt","","",1,null],[11,"set_param","","",1,null],[11,"new","","Creates a new decoder builder",11,{"inputs":[{"name":"r"}],"output":{"name":"decoder"}}],[11,"read_info","","Reads the logical screen descriptor including the global color palette",11,null],[11,"next_frame_info","","Returns the next frame info",12,null],[11,"read_next_frame","","Reads the next frame from the image.",12,null],[11,"fill_buffer","","Reads data of the current frame into a pre-allocated buffer.",12,null],[11,"buffer_size","","Output buffer size",12,null],[11,"line_length","","Line length of the current frame",12,null],[11,"palette","","Returns the color palette relevant for the current (next) frame",12,null],[11,"global_palette","","The global color palette",12,null],[11,"width","","Width of the image",12,null],[11,"height","","Height of the image",12,null],[11,"bg_color","","Index of the background color in the global palette",12,null],[11,"new_control_ext","","Constructor for control extension data.",9,{"inputs":[{"name":"u16"},{"name":"disposalmethod"},{"name":"bool"},{"name":"option"}],"output":{"name":"extensiondata"}}],[11,"write_frame","","Writes a complete frame to the image",13,null],[11,"write_extension","","Writes an extension to the image",13,null],[11,"write_raw_extension","","Writes a raw extension to the image",13,null],[11,"drop","","",13,null],[11,"new","","Creates a new encoder.",14,{"inputs":[{"name":"w"},{"name":"u16"},{"name":"u16"}],"output":{"name":"self"}}],[11,"write_global_palette","","Writes the global color palette",14,null],[8,"SetParameter","","Implemented for objects that have parameters.",null,null],[11,"set","","Sets `value` as a parameter of `self`.",15,null],[8,"Parameter","","Configuration parameter trait.",null,null],[10,"set_param","","Sets `self` as a parameter of `Object`.",16,null],[11,"set","","Sets `value` as a parameter of `self`.",15,null]],"paths":[[3,"Frame"],[3,"MemoryLimit"],[4,"Block"],[4,"Extension"],[4,"DisposalMethod"],[4,"Decoded"],[4,"DecodingError"],[4,"ColorOutput"],[4,"Extensions"],[4,"ExtensionData"],[3,"StreamingDecoder"],[3,"Decoder"],[3,"Reader"],[3,"Writer"],[3,"Encoder"],[8,"SetParameter"],[8,"Parameter"]]};
initSearch(searchIndex);