package vendor:sdl3/ttf
⌘K
Ctrl+K
or
/
Index
Constants (26)
- FONT_WEIGHT_BLACK
- FONT_WEIGHT_BOLD
- FONT_WEIGHT_EXTRA_BLACK
- FONT_WEIGHT_EXTRA_BOLD
- FONT_WEIGHT_EXTRA_LIGHT
- FONT_WEIGHT_LIGHT
- FONT_WEIGHT_MEDIUM
- FONT_WEIGHT_NORMAL
- FONT_WEIGHT_SEMI_BOLD
- FONT_WEIGHT_THIN
- MAJOR_VERSION
- MINOR_VERSION
- PATCHLEVEL
- PROP_FONT_CREATE_EXISTING_FONT
- PROP_FONT_CREATE_FACE_NUMBER
- PROP_FONT_CREATE_FILENAME_STRING
- PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER
- PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN
- PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER
- PROP_FONT_CREATE_IOSTREAM_POINTER
- PROP_FONT_CREATE_SIZE_FLOAT
- PROP_FONT_CREATE_VERTICAL_DPI_NUMBER
- PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE
- PROP_GPU_TEXT_ENGINE_DEVICE
- PROP_RENDERER_TEXT_ENGINE_ATLAS_TEXTURE_SIZE
- PROP_RENDERER_TEXT_ENGINE_RENDERER
Variables (0)
This section is empty.
Procedures (117)
- AddFallbackFont
- AppendTextString
- ClearFallbackFonts
- CloseFont
- CopyFont
- CreateGPUTextEngine
- CreateGPUTextEngineWithProperties
- CreateRendererTextEngine
- CreateRendererTextEngineWithProperties
- CreateSurfaceTextEngine
- CreateText
- DeleteTextString
- DestroyGPUTextEngine
- DestroyRendererTextEngine
- DestroySurfaceTextEngine
- DestroyText
- DrawRendererText
- DrawSurfaceText
- FontHasGlyph
- FontIsFixedWidth
- FontIsScalable
- GetFontAscent
- GetFontDPI
- GetFontDescent
- GetFontDirection
- GetFontFamilyName
- GetFontGeneration
- GetFontHeight
- GetFontHinting
- GetFontKerning
- GetFontLineSkip
- GetFontOutline
- GetFontProperties
- GetFontSDF
- GetFontScript
- GetFontSize
- GetFontStyle
- GetFontStyleName
- GetFontWeight
- GetFontWrapAlignment
- GetFreeTypeVersion
- GetGPUTextDrawData
- GetGPUTextEngineWinding
- GetGlyphImage
- GetGlyphImageForIndex
- GetGlyphKerning
- GetGlyphMetrics
- GetGlyphScript
- GetHarfBuzzVersion
- GetNextTextSubString
- GetNumFontFaces
- GetPreviousTextSubString
- GetStringSize
- GetStringSizeWrapped
- GetTextColor
- GetTextColorFloat
- GetTextDirection
- GetTextEngine
- GetTextFont
- GetTextPosition
- GetTextProperties
- GetTextScript
- GetTextSize
- GetTextSubString
- GetTextSubStringForLine
- GetTextSubStringForPoint
- GetTextSubStringsForRange
- GetTextWrapWidth
- Init
- InsertTextString
- MeasureString
- OpenFont
- OpenFontIO
- OpenFontWithProperties
- Quit
- RemoveFallbackFont
- RenderGlyph_Blended
- RenderGlyph_LCD
- RenderGlyph_Shaded
- RenderGylph_Solid
- RenderText_Blended
- RenderText_Blended_Wrapped
- RenderText_LCD
- RenderText_LCD_Wrapped
- RenderText_Shaded
- RenderText_Shaded_Wrapped
- RenderText_Solid
- RenderText_Solid_Wrapped
- SetFontDirection
- SetFontHinting
- SetFontKerning
- SetFontLanguage
- SetFontLineSkip
- SetFontOutline
- SetFontSDF
- SetFontScript
- SetFontSize
- SetFontSizeDPI
- SetFontStyle
- SetFontWrapAlignment
- SetGPUTextEngineWinding
- SetTextColor
- SetTextColorFloat
- SetTextDirection
- SetTextEngine
- SetTextFont
- SetTextPosition
- SetTextScript
- SetTextString
- SetTextWrapWhitespaceVisible
- SetTextWrapWidth
- StringToTag
- TagToString
- TextWrapWhitespaceVisible
- UpdateText
- Version
- WasInit
Procedure Groups (0)
This section is empty.
Types
Direction ¶
Direction :: enum i32 { INVALID, LTR = 4, RTL, TTB, BTT, }
Related Procedures With Parameters
Related Procedures With Returns
DrawCommand ¶
DrawCommand :: enum i32 { NOOP, FILL, COPY, }
DrawOperation ¶
DrawOperation :: struct #raw_union { cmd: DrawCommand, fill: FillOperation, copy: CopyOperation, }
FillOperation ¶
FillOperation :: struct { cmd: DrawCommand, rect: sdl3.Rect, }
Font ¶
Font :: struct {}
Related Procedures With Parameters
- AddFallbackFont
- ClearFallbackFonts
- CloseFont
- CopyFont
- CreateText
- FontHasGlyph
- FontIsFixedWidth
- FontIsScalable
- GetFontAscent
- GetFontDPI
- GetFontDescent
- GetFontDirection
- GetFontFamilyName
- GetFontGeneration
- GetFontHeight
- GetFontHinting
- GetFontKerning
- GetFontLineSkip
- GetFontOutline
- GetFontProperties
- GetFontSDF
- GetFontScript
- GetFontSize
- GetFontStyle
- GetFontStyleName
- GetFontWeight
- GetFontWrapAlignment
- GetGlyphImage
- GetGlyphImageForIndex
- GetGlyphKerning
- GetGlyphMetrics
- GetNumFontFaces
- GetStringSize
- GetStringSizeWrapped
- MeasureString
- RemoveFallbackFont
- RenderGlyph_Blended
- RenderGlyph_LCD
- RenderGlyph_Shaded
- RenderGylph_Solid
- RenderText_Blended
- RenderText_Blended_Wrapped
- RenderText_LCD
- RenderText_LCD_Wrapped
- RenderText_Shaded
- RenderText_Shaded_Wrapped
- RenderText_Solid
- RenderText_Solid_Wrapped
- SetFontDirection
- SetFontHinting
- SetFontKerning
- SetFontLanguage
- SetFontLineSkip
- SetFontOutline
- SetFontSDF
- SetFontScript
- SetFontSize
- SetFontSizeDPI
- SetFontStyle
- SetFontWrapAlignment
- SetTextFont
Related Procedures With Returns
FontStyle ¶
FontStyle :: enum u32 { BOLD, ITALIC, UNDERLINE, STRIKETHROUGH, }
GPUAtlasDrawSequence ¶
GPUAtlasDrawSequence :: struct { atlas_texture: ^sdl3.GPUTexture, xy: [^]sdl3.FPoint `fmt:"v,num_vertices"`, uv: [^]sdl3.FPoint `fmt:"v,num_vertices"`, num_vertices: i32, indices: [^]i32 `fmt:"v,num_indices"`, num_indices: i32, image_type: ImageType, next: ^GPUAtlasDrawSequence, }
Related Procedures With Returns
GPUTextEngineWinding ¶
GPUTextEngineWinding :: enum i32 { INVALID = -1, CLOCKWISE = 0, COUNTER_CLOCKWISE = 1, }
Related Procedures With Parameters
Related Procedures With Returns
Hinting ¶
Hinting :: enum i32 { INVALID = -1, NORMAL, LIGHT, MONO, NONE, LIGHT_SUBPIXEL, }
NOTE: This is called TTF_HintingFlags but its not a bit_set so the "flags" doesnt really make sense, its just the hinting.
Related Procedures With Parameters
Related Procedures With Returns
HorizontalAlignment ¶
HorizontalAlignment :: enum i32 { INVALID = -1, LEFT, CENTER, RIGHT, }
Related Procedures With Parameters
Related Procedures With Returns
ImageType ¶
ImageType :: enum i32 { INVALID, ALPHA, COLOR, SDF, }
Related Procedures With Parameters
SubString ¶
SubString :: struct { flags: SubStringFlags, offset: i32, length: i32, line_index: i32, cluster_index: i32, rect: sdl3.Rect, }
Related Procedures With Parameters
Text ¶
Related Procedures With Parameters
- AppendTextString
- DeleteTextString
- DestroyText
- DrawRendererText
- DrawSurfaceText
- GetGPUTextDrawData
- GetNextTextSubString
- GetPreviousTextSubString
- GetTextColor
- GetTextColorFloat
- GetTextDirection
- GetTextEngine
- GetTextFont
- GetTextPosition
- GetTextProperties
- GetTextScript
- GetTextSize
- GetTextSubString
- GetTextSubStringForLine
- GetTextSubStringForPoint
- GetTextSubStringsForRange
- GetTextWrapWidth
- InsertTextString
- SetTextColor
- SetTextColorFloat
- SetTextDirection
- SetTextEngine
- SetTextFont
- SetTextPosition
- SetTextScript
- SetTextString
- SetTextWrapWhitespaceVisible
- SetTextWrapWidth
- TextWrapWhitespaceVisible
- UpdateText
Related Procedures With Returns
TextData ¶
TextData :: struct { font: ^Font, color: sdl3.FColor, needs_layout_update: bool, layout: ^TextLayout, x: i32, y: i32, w: i32, h: i32, num_ops: i32, ops: [^]DrawOperation `fmt:"v,num_ops"`, num_clusters: i32, clusters: [^]SubString `fmt:"v,num_clusters"`, props: sdl3.PropertiesID, needs_engine_update: bool, engine: ^TextEngine, engine_text: rawptr, }
TextEngine ¶
TextEngine :: struct { version: u32, userdata: rawptr, CreateText: proc "c" (userdata: rawptr, text: ^Text) -> bool, DestroyText: proc "c" (userdata: rawptr, Textext: ^Text), }
Related Procedures With Parameters
- CreateText
- DestroyGPUTextEngine
- DestroyRendererTextEngine
- DestroySurfaceTextEngine
- GetGPUTextEngineWinding
- SetGPUTextEngineWinding
- SetTextEngine
Related Procedures With Returns
TextLayout ¶
TextLayout :: struct {}
Constants
FONT_WEIGHT_EXTRA_BLACK ¶
FONT_WEIGHT_EXTRA_BLACK: int : 950
*< ExtraBlack (950) named font weight value
FONT_WEIGHT_EXTRA_BOLD ¶
FONT_WEIGHT_EXTRA_BOLD: int : 800
*< ExtraBold (800) named font weight value
FONT_WEIGHT_EXTRA_LIGHT ¶
FONT_WEIGHT_EXTRA_LIGHT: int : 200
*< ExtraLight (200) named font weight value
MAJOR_VERSION ¶
MAJOR_VERSION: int : 3
MINOR_VERSION ¶
MINOR_VERSION: int : 2
PATCHLEVEL ¶
PATCHLEVEL: int : 2
PROP_FONT_CREATE_EXISTING_FONT ¶
PROP_FONT_CREATE_EXISTING_FONT :: "SDL_ttf.font.create.existing_font"
PROP_FONT_CREATE_FACE_NUMBER ¶
PROP_FONT_CREATE_FACE_NUMBER :: "SDL_ttf.font.create.face"
PROP_FONT_CREATE_FILENAME_STRING ¶
PROP_FONT_CREATE_FILENAME_STRING :: "SDL_ttf.font.create.filename"
PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER ¶
PROP_FONT_CREATE_HORIZONTAL_DPI_NUMBER :: "SDL_ttf.font.create.hdpi"
PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN ¶
PROP_FONT_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN :: "SDL_ttf.font.create.iostream.autoclose"
PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER ¶
PROP_FONT_CREATE_IOSTREAM_OFFSET_NUMBER :: "SDL_ttf.font.create.iostream.offset"
PROP_FONT_CREATE_IOSTREAM_POINTER ¶
PROP_FONT_CREATE_IOSTREAM_POINTER :: "SDL_ttf.font.create.iostream"
PROP_FONT_CREATE_SIZE_FLOAT ¶
PROP_FONT_CREATE_SIZE_FLOAT :: "SDL_ttf.font.create.size"
PROP_FONT_CREATE_VERTICAL_DPI_NUMBER ¶
PROP_FONT_CREATE_VERTICAL_DPI_NUMBER :: "SDL_ttf.font.create.vdpi"
PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE ¶
PROP_GPU_TEXT_ENGINE_ATLAS_TEXTURE_SIZE :: "SDL_ttf.gpu_text_engine.create.atlas_texture_size"
PROP_GPU_TEXT_ENGINE_DEVICE ¶
PROP_GPU_TEXT_ENGINE_DEVICE :: "SDL_ttf.gpu_text_engine.create.device"
PROP_RENDERER_TEXT_ENGINE_ATLAS_TEXTURE_SIZE ¶
PROP_RENDERER_TEXT_ENGINE_ATLAS_TEXTURE_SIZE :: "SDL_ttf.renderer_text_engine.create.atlas_texture_size"
PROP_RENDERER_TEXT_ENGINE_RENDERER ¶
PROP_RENDERER_TEXT_ENGINE_RENDERER :: "SDL_ttf.renderer_text_engine.create.renderer"
Variables
This section is empty.
Procedures
ClearFallbackFonts ¶
ClearFallbackFonts :: proc "c" (font: ^Font) ---
CloseFont ¶
CloseFont :: proc "c" (font: ^Font) ---
CreateGPUTextEngine ¶
CreateGPUTextEngine :: proc "c" (device: ^sdl3.GPUDevice) -> ^TextEngine ---
CreateGPUTextEngineWithProperties ¶
CreateGPUTextEngineWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^TextEngine ---
CreateRendererTextEngine ¶
CreateRendererTextEngine :: proc "c" (renderer: ^sdl3.Renderer) -> ^TextEngine ---
CreateRendererTextEngineWithProperties ¶
CreateRendererTextEngineWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^TextEngine ---
CreateSurfaceTextEngine ¶
CreateSurfaceTextEngine :: proc "c" () -> ^TextEngine ---
CreateText ¶
CreateText :: proc "c" (engine: ^TextEngine, font: ^Font, text: cstring, length: uint) -> ^Text ---
DestroyGPUTextEngine ¶
DestroyGPUTextEngine :: proc "c" (engine: ^TextEngine) ---
DestroyRendererTextEngine ¶
DestroyRendererTextEngine :: proc "c" (engine: ^TextEngine) ---
DestroySurfaceTextEngine ¶
DestroySurfaceTextEngine :: proc "c" (engine: ^TextEngine) ---
DestroyText ¶
DestroyText :: proc "c" (text: ^Text) ---
GetFontProperties ¶
GetFontProperties :: proc "c" (font: ^Font) -> sdl3.PropertiesID ---
GetFontStyle ¶
GetFontStyle :: proc "c" (#by_ptr font: Font) -> FontStyleFlags ---
GetFontWrapAlignment ¶
GetFontWrapAlignment :: proc "c" (#by_ptr font: Font) -> HorizontalAlignment ---
GetFreeTypeVersion ¶
GetFreeTypeVersion :: proc "c" (major, minor, patch: ^i32) ---
GetGPUTextDrawData ¶
GetGPUTextDrawData :: proc "c" (text: ^Text) -> ^GPUAtlasDrawSequence ---
GetGPUTextEngineWinding ¶
GetGPUTextEngineWinding :: proc "c" (#by_ptr engine: TextEngine) -> GPUTextEngineWinding ---
GetHarfBuzzVersion ¶
GetHarfBuzzVersion :: proc "c" (major, minor, patch: ^i32) ---
GetTextEngine ¶
GetTextEngine :: proc "c" (text: ^Text) -> ^TextEngine ---
GetTextProperties ¶
GetTextProperties :: proc "c" (text: ^Text) -> sdl3.PropertiesID ---
OpenFontWithProperties ¶
OpenFontWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^Font ---
SetFontStyle ¶
SetFontStyle :: proc "c" (font: ^Font, style: FontStyleFlags) ---
SetFontWrapAlignment ¶
SetFontWrapAlignment :: proc "c" (font: ^Font, align: HorizontalAlignment) ---
SetGPUTextEngineWinding ¶
SetGPUTextEngineWinding :: proc "c" (engine: ^TextEngine, winding: GPUTextEngineWinding) ---
SetTextEngine ¶
SetTextEngine :: proc "c" (text: ^Text, engine: ^TextEngine) -> bool ---
Procedure Groups
This section is empty.
Source Files
Generation Information
Generated with odin version dev-2025-06 (vendor "odin") Windows_amd64 @ 2025-06-04 21:11:02.003569700 +0000 UTC