var searchIndex = {};
searchIndex["sdl2_ttf"] = {"doc":"A binding for SDL2_ttf.","items":[[3,"Sdl2TtfContext","sdl2_ttf","A context manager for `SDL2_TTF` to manage C code initialization and clean-up.",null,null],[3,"Font","","A loaded TTF font.",null,null],[3,"FontStyle","","The styling of a font.",null,null],[3,"GlyphMetrics","","Information about a specific glyph (character) in a font face.",null,null],[12,"minx","","",0,null],[12,"maxx","","",0,null],[12,"miny","","",0,null],[12,"maxy","","",0,null],[12,"advance","","",0,null],[3,"PartialRendering","","A builder for a font rendering.",null,null],[4,"Hinting","","Information about the hinting of a font.\nSee [wikipedia](https://en.wikipedia.org/wiki/Font_hinting)",null,null],[13,"Normal","","",1,null],[13,"Light","","",1,null],[13,"Mono","","",1,null],[13,"None","","",1,null],[4,"FontError","","A font-related error.",null,null],[13,"InvalidLatin1Text","","A Latin-1 encoded byte string is invalid.",2,null],[13,"SdlError","","A SDL2-related error occured.",2,null],[5,"init","","Initializes the truetype font API and returns a context manager which will\nclean up the library once it goes out of scope.",null,{"inputs":[],"output":{"name":"result"}}],[5,"has_been_initialized","","Returns whether library has been initialized already.",null,{"inputs":[],"output":{"name":"bool"}}],[5,"get_linked_version","","Returns the version of the dynamically linked `SDL_TTF` library",null,{"inputs":[],"output":{"name":"version"}}],[11,"hash","","",3,null],[11,"cmp","","",3,null],[11,"partial_cmp","","",3,null],[11,"lt","","",3,null],[11,"le","","",3,null],[11,"gt","","",3,null],[11,"ge","","",3,null],[11,"clone","","",3,null],[11,"eq","","",3,null],[11,"ne","","",3,null],[11,"fmt","","",3,null],[11,"empty","","Returns an empty set of flags.",3,{"inputs":[],"output":{"name":"fontstyle"}}],[11,"all","","Returns the set containing all flags.",3,{"inputs":[],"output":{"name":"fontstyle"}}],[11,"bits","","Returns the raw value of the flags currently stored.",3,null],[11,"from_bits","","Convert from underlying bit representation, unless that\nrepresentation contains bits that do not correspond to a flag.",3,{"inputs":[{"name":"c_int"}],"output":{"name":"option"}}],[11,"from_bits_truncate","","Convert from underlying bit representation, dropping any bits\nthat do not correspond to flags.",3,{"inputs":[{"name":"c_int"}],"output":{"name":"fontstyle"}}],[11,"is_empty","","Returns `true` if no flags are currently stored.",3,null],[11,"is_all","","Returns `true` if all flags are currently set.",3,null],[11,"intersects","","Returns `true` if there are flags common to both `self` and `other`.",3,null],[11,"contains","","Returns `true` all of the flags in `other` are contained within `self`.",3,null],[11,"insert","","Inserts the specified flags in-place.",3,null],[11,"remove","","Removes the specified flags in-place.",3,null],[11,"toggle","","Toggles the specified flags in-place.",3,null],[11,"bitor","","Returns the union of the two sets of flags.",3,null],[11,"bitor_assign","","Adds the set of flags.",3,null],[11,"bitxor","","Returns the left flags, but with all the right flags toggled.",3,null],[11,"bitxor_assign","","Toggles the set of flags.",3,null],[11,"bitand","","Returns the intersection between the two sets of flags.",3,null],[11,"bitand_assign","","Disables all flags disabled in the set.",3,null],[11,"sub","","Returns the set difference of the two sets of flags.",3,null],[11,"sub_assign","","Disables all flags enabled in the set.",3,null],[11,"not","","Returns the complement of this set of flags.",3,null],[11,"from_iter","","",3,{"inputs":[{"name":"t"}],"output":{"name":"fontstyle"}}],[11,"clone","","",1,null],[11,"eq","","",1,null],[11,"fmt","","",1,null],[11,"clone","","",0,null],[11,"eq","","",0,null],[11,"ne","","",0,null],[11,"fmt","","",0,null],[11,"fmt","","",2,null],[11,"description","","",2,null],[11,"cause","","",2,null],[11,"fmt","","",2,null],[11,"solid","","Renders the text in *solid* mode.\nSee [the SDL2_TTF docs](https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC42)\nfor an explanation.",4,null],[11,"shaded","","Renders the text in *shaded* mode.\nSee [the SDL2_TTF docs](https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC42)\nfor an explanation.",4,null],[11,"blended","","Renders the text in *blended* mode.\nSee [the SDL2_TTF docs](https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC42)\nfor an explanation.",4,null],[11,"blended_wrapped","","Renders the text in *blended* mode but wrapping the words if the width\nexceeds the given maximum width.\nSee [the SDL2_TTF docs](https://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html#SEC42)\nfor an explanation of the mode.",4,null],[11,"eq","","",5,null],[11,"ne","","",5,null],[11,"drop","","",5,null],[11,"render","","Starts specifying a rendering of the given UTF-8-encoded text.",5,null],[11,"render_latin1","","Starts specifying a rendering of the given Latin-1-encoded text.",5,null],[11,"render_char","","Starts specifying a rendering of the given UTF-8-encoded character.",5,null],[11,"size_of","","Returns the width and height of the given text when rendered using this\nfont.",5,null],[11,"size_of_latin1","","Returns the width and height of the given text when rendered using this\nfont.",5,null],[11,"size_of_char","","Returns the width and height of the given text when rendered using this\nfont.",5,null],[11,"get_style","","Returns the font's style flags.",5,null],[11,"set_style","","Sets the font's style flags.",5,null],[11,"get_outline_width","","Returns the width of the font's outline.",5,null],[11,"set_outline_width","","Sets the width of the font's outline.",5,null],[11,"get_hinting","","Returns the font's freetype hints.",5,null],[11,"set_hinting","","Sets the font's freetype hints.",5,null],[11,"get_kerning","","Returns whether the font is kerning.",5,null],[11,"set_kerning","","Sets whether the font should use kerning.",5,null],[11,"height","","Get font maximum total height.",5,null],[11,"ascent","","Returns the font's highest ascent (height above base).",5,null],[11,"descent","","Returns the font's lowest descent (height below base).\nThis is a negative number.",5,null],[11,"recommended_line_spacing","","Returns the recommended line spacing for text rendered with this font.",5,null],[11,"face_count","","Returns the number of faces in this font.",5,null],[11,"face_is_fixed_width","","Returns whether the font is monospaced.",5,null],[11,"face_family_name","","Returns the family name of the current font face.",5,null],[11,"face_style_name","","Returns the name of the current font face.",5,null],[11,"find_glyph","","Returns the index of the given character in this font face.",5,null],[11,"find_glyph_metrics","","Returns the glyph metrics of the given character in this font face.",5,null],[11,"drop","","",6,null],[11,"load_font","","Loads a font from the given file with the given size in points.",6,null],[11,"load_font_at_index","","Loads the font at the given index of the file, with the given\nsize in points.",6,null],[11,"load_font_from_rwops","","Loads a font from the given SDL2 rwops object with the given size in\npoints.",6,null],[11,"load_font_at_index_from_rwops","","Loads the font at the given index of the SDL2 rwops object with\nthe given size in points.",6,null],[6,"FontResult","","The result of an `SDL2_TTF` font operation.",null,null],[17,"STYLE_NORMAL","","",null,null],[17,"STYLE_BOLD","","",null,null],[17,"STYLE_ITALIC","","",null,null],[17,"STYLE_UNDERLINE","","",null,null],[17,"STYLE_STRIKETHROUGH","","",null,null]],"paths":[[3,"GlyphMetrics"],[4,"Hinting"],[4,"FontError"],[3,"FontStyle"],[3,"PartialRendering"],[3,"Font"],[3,"Sdl2TtfContext"]]};
initSearch(searchIndex);