Odin SDL3 Vendor Bindings

https://pkg.odin-lang.org/vendor/sdl3/
Admin
Odin language bindings for SDL3 (Simple DirectMedia Layer 3) and related libraries including SDL3...
Tokens:49,172
Snippets:584
Trust Score:8.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Font Hinting

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the current hinting setting for the font.

```odin
GetFontHinting :: proc "c" (font: ^Font) -> Hinting ---
```

--------------------------------

### Get Text Engine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the TextEngine associated with a Text object.

```odin
GetTextEngine :: proc "c" (text: ^Text) -> ^TextEngine ---
```

--------------------------------

### Get Text Script

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the script information (e.g., Unicode script) for a Text object.

```odin
GetTextScript :: proc "c" (text: ^Text) -> u32 ---
```

--------------------------------

### Get Clipboard Image

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Retrieves the image data currently stored in the system clipboard. Returns a pointer to an SDL3 Surface.

```odin
GetClipboardImage :: proc "c" () -> ^sdl3.Surface ---
```

--------------------------------

### Get Text Size

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Calculates the width and height of a Text object. Returns false if the calculation fails.

```odin
GetTextSize :: proc "c" (text: ^Text, w, h: ^i32) -> bool ---
```

--------------------------------

### Get Font Outline Thickness

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the outline thickness setting for the font.

```odin
GetFontOutline :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### Init

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Initializes the SDL3 font module.

```APIDOC
## Init

### Description
Initializes the SDL3 font module. This must be called before using most font functions.

### Method
Call

### Return Value
- **bool** - True if initialization was successful, false otherwise.
```

--------------------------------

### Get Next Text Substring

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the next substring from a Text object, starting from the current position. Returns false if there are no more substrings.

```odin
GetNextTextSubString :: proc "c" (text: ^Text, #by_ptr substring: SubString, next: ^SubString) -> bool ---
```

--------------------------------

### CreateGPUTextEngineWithProperties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a GPU-accelerated text engine with specified properties. This allows for more control over the engine's initialization.

```APIDOC
## CreateGPUTextEngineWithProperties

### Description
Creates a GPU-accelerated text engine with specified properties.

### Method
Call

### Parameters
#### Path Parameters
- **props** (sdl3.PropertiesID) - Required - The properties to use for creating the text engine.

### Response
#### Success Response
- **TextEngine** (^TextEngine) - A pointer to the newly created TextEngine.
```

--------------------------------

### GetNumFontFaces

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Gets the number of faces in a font.

```APIDOC
## GetNumFontFaces

### Description
Gets the number of faces available in a font.

### Method
Call

### Parameters
- **font** (^Font) - A pointer to the Font object.

### Return Value
- **i32** - The number of font faces.
```

--------------------------------

### Initialize SDL3 Text Module

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Initializes the SDL3 text module. Must be called before using other text functions. Returns true on success, false otherwise.

```odin
Init :: proc "c" () -> bool ---
```

--------------------------------

### Get String Size

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Calculates the width and height of a given string using a specified font. Returns false if the calculation fails.

```odin
GetStringSize :: proc "c" (font: ^Font, text: cstring, length: uint, w, h: ^i32) -> bool ---
```

--------------------------------

### Get Font Size

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the nominal font size in points.

```odin
GetFontSize :: proc "c" (font: ^Font) -> f32 ---
```

--------------------------------

### Create Renderer Text Engine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine that renders to an SDL renderer. Requires a Renderer.

```odin
CreateRendererTextEngine :: proc "c" (renderer: ^sdl3.Renderer) -> ^TextEngine ---
```

--------------------------------

### Get Font Properties ID

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the PropertiesID associated with the font.

```odin
GetFontProperties :: proc "c" (font: ^Font) -> sdl3.PropertiesID ---
```

--------------------------------

### Load QOI Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a QOI image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadQOI_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Font Kerning Support

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Checks if kerning is enabled for the font.

```odin
GetFontKerning :: proc "c" (font: ^Font) -> bool ---
```

--------------------------------

### LoadQOI_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a QOI image from an SDL3 IOStream.

```APIDOC
## LoadQOI_IO

### Description
Loads a QOI image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### LoadXPM_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an XPM image from an SDL3 IOStream.

```APIDOC
## LoadXPM_IO

### Description
Loads an XPM image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Text Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the properties ID associated with a Text object.

```odin
GetTextProperties :: proc "c" (text: ^Text) -> sdl3.PropertiesID ---
```

--------------------------------

### Load WEBP Animation from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a WEBP animation from an SDL IOStream. Requires the SDL3 library.

```odin
LoadWEBPAnimation_IO :: proc "c" (src: ^sdl3.IOStream) -> ^Animation ---
```

--------------------------------

### Load WEBP Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a WEBP image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadWEBP_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Text Font

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the Font object used by a Text object.

```odin
GetTextFont :: proc "c" (text: ^Text) -> ^Font ---
```

--------------------------------

### Open Font from File

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Opens a font from a specified file path with a given point size. Returns a pointer to the Font object.

```odin
OpenFont :: proc "c" (file: cstring, ptsize: f32) -> ^Font ---
```

--------------------------------

### Get Font Script Tag

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the OpenType script tag for the font.

```odin
GetFontScript :: proc "c" (font: ^Font) -> u32 ---
```

--------------------------------

### Create Animation Decoder from File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Creates an animation decoder from a file path. The module will handle opening and reading the file.

```odin
CreateAnimationDecoder :: proc "c" (file: cstring) -> ^AnimationDecoder ---
```

--------------------------------

### Get String Size Wrapped

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Calculates the width and height of a string, considering a maximum wrap width. Returns false if the calculation fails.

```odin
GetStringSizeWrapped :: proc "c" (
	font:       ^Font,
	text:       cstring,
	length:     uint,
	wrap_width: i32,
	w, 
	h:          ^i32,
) -> bool ---
```

--------------------------------

### Get Glyph Metrics

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the bounding box, minimum and maximum coordinates, and advance width for a given glyph. Returns true if metrics are available.

```odin
GetGlyphMetrics :: proc "c" (
	font:                   ^Font, 
	ch:                     u32,
	minx, maxx, miny, maxy, 
	advance:                ^i32,
) -> bool ---
```

--------------------------------

### Get Glyph Script Tag

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the OpenType script tag for a specific character.

```odin
GetGlyphScript :: proc "c" (ch: u32) -> u32 ---
```

--------------------------------

### Create GPU Text Engine with Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine using the GPU with specified properties. Requires a PropertiesID.

```odin
CreateGPUTextEngineWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^TextEngine ---
```

--------------------------------

### Get Font Line Skip

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the recommended distance between lines of text for this font.

```odin
GetFontLineSkip :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### LoadWEBP_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a WEBP image from an SDL3 IOStream.

```APIDOC
## LoadWEBP_IO

### Description
Loads a WEBP image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Font Height

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the total height of the font, typically ascent + descent.

```odin
GetFontHeight :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### Create Renderer Text Engine with Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine for a renderer with specified properties. Requires a PropertiesID.

```odin
CreateRendererTextEngineWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^TextEngine ---
```

--------------------------------

### Create Surface Text Engine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine that renders to an SDL surface. This is a basic text engine without specific device or renderer dependencies.

```odin
CreateSurfaceTextEngine :: proc "c" () -> ^TextEngine ---
```

--------------------------------

### Get Font Family Name

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the family name of the font as a C-style string.

```odin
GetFontFamilyName :: proc "c" (font: ^Font) -> cstring ---
```

--------------------------------

### Open Font with Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Opens a font using a set of properties identified by an `sdl3.PropertiesID`. Returns a pointer to the Font object.

```odin
OpenFontWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^Font ---
```

--------------------------------

### Get Font Direction

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the default directionality of the font (e.g., left-to-right, right-to-left).

```odin
GetFontDirection :: proc "c" (font: ^Font) -> Direction ---
```

--------------------------------

### CreateGPUTextEngine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a GPU-accelerated text engine. This function requires a valid GPUDevice to be provided.

```APIDOC
## CreateGPUTextEngine

### Description
Creates a GPU-accelerated text engine.

### Method
Call

### Parameters
#### Path Parameters
- **device** (^sdl3.GPUDevice) - Required - The GPU device to use for the text engine.

### Response
#### Success Response
- **TextEngine** (^TextEngine) - A pointer to the newly created TextEngine.
```

--------------------------------

### Get SDL3 Text Engine Version

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the version of the SDL3 text engine as an integer.

```odin
Version :: proc "c" () -> i32 ---
```

--------------------------------

### LoadPCX_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PCX image from an SDL3 IOStream.

```APIDOC
## LoadPCX_IO

### Description
Loads a PCX image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Text Direction

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the text direction (e.g., left-to-right, right-to-left) of a Text object.

```odin
GetTextDirection :: proc "c" (text: ^Text) -> Direction ---
```

--------------------------------

### LoadXV_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an XV image from an SDL3 IOStream.

```APIDOC
## LoadXV_IO

### Description
Loads an XV image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Load PCX Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PCX image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadPCX_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Font Wrap Alignment

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the horizontal alignment setting used for text wrapping.

```odin
GetFontWrapAlignment :: proc "c" (font: ^Font) -> HorizontalAlignment ---
```

--------------------------------

### CreateRendererTextEngineWithProperties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine associated with an SDL3 renderer, using specified properties for initialization.

```APIDOC
## CreateRendererTextEngineWithProperties

### Description
Creates a text engine associated with an SDL3 renderer, using specified properties.

### Method
Call

### Parameters
#### Path Parameters
- **props** (sdl3.PropertiesID) - Required - The properties to use for creating the text engine.

### Response
#### Success Response
- **TextEngine** (^TextEngine) - A pointer to the newly created TextEngine.
```

--------------------------------

### Get Font Generation Number

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves a generation number for the font, useful for cache invalidation.

```odin
GetFontGeneration :: proc "c" (font: ^Font) -> u32 ---
```

--------------------------------

### LoadWEBPAnimation_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a WEBP animation from an SDL3 IOStream.

```APIDOC
## LoadWEBPAnimation_IO

### Description
Loads a WEBP animation from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^Animation) - A pointer to the loaded Animation.

#### Response Example
None
```

--------------------------------

### Get Number of Font Faces

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Returns the number of font faces available in a given Font object.

```odin
GetNumFontFaces :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### Load Texture from File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image directly into a render texture from a file path. Requires a renderer and a file path. Requires the SDL3 library.

```odin
LoadTexture :: proc "c" (renderer: ^sdl3.Renderer, file: cstring) -> ^sdl3.Texture ---
```

--------------------------------

### Get Text Position

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the (x, y) position of a Text object. Returns false if the retrieval fails.

```odin
GetTextPosition :: proc "c" (text: ^Text, x, y: ^i32) -> bool ---
```

--------------------------------

### Load_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image from an SDL3 IOStream.

```APIDOC
## Load_IO

### Description
Loads an image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Glyph Image Surface

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the surface representation of a glyph for a given character and image type.

```odin
GetGlyphImage :: proc "c" (font: ^Font, ch: u32, image_type: ^ImageType) -> ^sdl3.Surface ---
```

--------------------------------

### PROP_FONT_CREATE_FILENAME_STRING Constant

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Property constant for specifying the filename when creating a font.

```odin
PROP_FONT_CREATE_FILENAME_STRING :: "SDL_ttf.font.create.filename"
```

--------------------------------

### Load Image Surface from File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image from a file path and returns it as an SDL3 Surface. This is a convenience function for common image formats.

```odin
Load :: proc "c" (file: cstring) -> ^sdl3.Surface ---
```

--------------------------------

### Get GPU Text Engine Winding

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the winding rule used by a GPU text engine.

```odin
GetGPUTextEngineWinding :: proc "c" (#by_ptr engine: TextEngine) -> GPUTextEngineWinding ---
```

--------------------------------

### Load Generic Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a generic image from an SDL IOStream. Allows control over closing the IO stream. Requires the SDL3 library.

```odin
Load_IO :: proc "c" (src: ^sdl3.IOStream, closeio: bool) -> ^sdl3.Surface ---
```

--------------------------------

### Get Font Weight

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the numerical weight of the font (e.g., 400 for normal, 700 for bold).

```odin
GetFontWeight :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### Version

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Returns the version of the SDL3 Image library. This can be useful for checking compatibility or logging.

```APIDOC
## Version

### Description
Returns the version of the SDL3 Image library.

### Returns
* (Pointer to sdl3.Version) - A pointer to an sdl3.Version structure containing the major, minor, and patch version numbers.
```

--------------------------------

### Get Font Style Flags

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the style flags (e.g., bold, italic) applied to the font.

```odin
GetFontStyle :: proc "c" (font: ^Font) -> FontStyleFlags ---
```

--------------------------------

### GetAnimationDecoderStatus

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Gets the current status of an animation decoder. This can be used to check if decoding is OK, failed, or complete.

```APIDOC
## GetAnimationDecoderStatus

### Description
Gets the current status of an animation decoder.

### Parameters
* **decoder** (Pointer to AnimationDecoder) - A pointer to the AnimationDecoder.

### Returns
* (AnimationDecoderStatus) - The current status of the decoder.
```

--------------------------------

### Create GPU Text Engine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine that uses the GPU for rendering. Requires a GPUDevice.

```odin
CreateGPUTextEngine :: proc "c" (device: ^sdl3.GPUDevice) -> ^TextEngine ---
```

--------------------------------

### Get HarfBuzz Version

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the major, minor, and patch version numbers of the HarfBuzz library used by SDL3.

```odin
GetHarfBuzzVersion :: proc "c" (major, minor, patch: ^i32) ---
```

--------------------------------

### Load PNG Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PNG image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadPNG_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Load XV Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an XV image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadXV_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get GPU Text Draw Data

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the draw data for a text object intended for GPU rendering.

```odin
GetGPUTextDrawData :: proc "c" (text: ^Text) -> ^GPUAtlasDrawSequence ---
```

--------------------------------

### Get FreeType Version

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the major, minor, and patch version numbers of the FreeType library used by SDL3.

```odin
GetFreeTypeVersion :: proc "c" (major, minor, patch: ^i32) ---
```

--------------------------------

### Save Surface to File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves a surface to a file. Returns a boolean indicating success. Requires the SDL3 library.

```odin
Save :: proc "c" (surface: ^sdl3.Surface, file: cstring) -> bool ---
```

--------------------------------

### Get Font Descent

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the font's descent value, which is the distance from the baseline to the bottom of the lowest glyph.

```odin
GetFontDescent :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### LoadLBM_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an LBM image from an SDL3 IOStream.

```APIDOC
## LoadLBM_IO

### Description
Loads an LBM image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### LoadJPG_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a JPG image from an SDL3 IOStream.

```APIDOC
## LoadJPG_IO

### Description
Loads a JPG image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Font Ascent

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the font's ascent value, which is the distance from the baseline to the top of the highest glyph.

```odin
GetFontAscent :: proc "c" (font: ^Font) -> i32 ---
```

--------------------------------

### Check Initialization Status

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Checks if the SDL3 text engine has been initialized. Returns an integer status.

```odin
WasInit :: proc "c" () -> i32 ---
```

--------------------------------

### GetAnimationDecoderProperties

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Gets the properties of an animation decoder, such as dimensions and frame count. This function provides metadata about the animation being decoded.

```APIDOC
## GetAnimationDecoderProperties

### Description
Gets the properties of an animation decoder.

### Parameters
* **decoder** (Pointer to AnimationDecoder) - A pointer to the AnimationDecoder.
* **width** (Pointer to i32) - Pointer to store the width of the animation frames.
* **height** (Pointer to i32) - Pointer to store the height of the animation frames.
* **frameCount** (Pointer to i32) - Pointer to store the total number of frames in the animation.

### Returns
* (i32) - Returns 0 on success or a negative error code on failure.
```

--------------------------------

### OpenFontWithProperties

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Opens a font using a set of properties.

```APIDOC
## OpenFontWithProperties

### Description
Opens a font based on a set of properties identified by a PropertiesID.

### Method
Call

### Parameters
- **props** (sdl3.PropertiesID) - The identifier for the font properties.

### Return Value
- **^Font** - A pointer to the opened Font object, or nil if an error occurred.
```

--------------------------------

### Get Text Substring Information

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves a substring from a Text object based on offset. Returns false if the offset is invalid.

```odin
GetTextSubString :: proc "c" (text: ^Text, offset: i32, substring: ^SubString) -> bool ---
```

--------------------------------

### Create Animation Decoder with Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Creates an animation decoder using a set of predefined properties. This allows for more control over decoder initialization.

```odin
CreateAnimationDecoderWithProperties :: proc "c" (props: sdl3.PropertiesID) -> ^AnimationDecoder ---
```

--------------------------------

### Get Glyph Image Surface by Index

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the surface representation of a glyph using its glyph index and image type.

```odin
GetGlyphImageForIndex :: proc "c" (font: ^Font, glyph_index: u32, image_type: ^ImageType) -> ^sdl3.Surface ---
```

--------------------------------

### Create Animation Encoder from File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Creates an animation encoder to write an animation to a file. The module will handle file creation and writing.

```odin
CreateAnimationEncoder :: proc "c" (file: cstring) -> ^AnimationEncoder ---
```

--------------------------------

### Get Animation Decoder Status

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Retrieves the current status of the animation decoder. This can indicate if the decoder is ready, failed, or finished.

```odin
GetAnimationDecoderStatus :: proc "c" (decoder: ^AnimationDecoder) -> AnimationDecoderStatus ---
```

--------------------------------

### Get Animation Decoder Properties

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Retrieves the properties associated with an animation decoder. These properties can be used to configure other related functions.

```odin
GetAnimationDecoderProperties :: proc "c" (decoder: ^AnimationDecoder) -> sdl3.PropertiesID ---
```

--------------------------------

### Render Text (Solid)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders an entire string to a new Surface using solid color blending. Requires a Font, text string, length, and foreground color.

```odin
RenderText_Solid :: proc "c" (font: ^Font, text: cstring, length: uint, fg: sdl3.Color) -> ^sdl3.Surface ---
```

--------------------------------

### OpenFontIO

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Opens a font from an IOStream.

```APIDOC
## OpenFontIO

### Description
Opens a font from an SDL_IOStream object. Allows loading fonts from memory or custom I/O sources.

### Method
Call

### Parameters
- **src** (^sdl3.IOStream) - A pointer to the SDL_IOStream object.
- **closeio** (bool) - If true, the IOStream will be closed after loading the font.
- **ptsize** (f32) - The desired point size of the font.

### Return Value
- **^Font** - A pointer to the opened Font object, or nil if an error occurred.
```

--------------------------------

### Get Font DPI

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the horizontal and vertical DPI (dots per inch) of the font. Returns true if successful.

```odin
GetFontDPI :: proc "c" (font: ^Font, hdpi: ^i32, vdpi: ^i32) -> bool ---
```

--------------------------------

### Load JPG Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a JPG image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadJPG_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### LoadPNG_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PNG image from an SDL3 IOStream.

```APIDOC
## LoadPNG_IO

### Description
Loads a PNG image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Text Wrap Width

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the current wrap width setting for a Text object. Returns false if the operation fails.

```odin
GetTextWrapWidth :: proc "c" (text: ^Text, wrap_width: ^i32) -> bool ---
```

--------------------------------

### Render Text Wrapped (Solid)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders an entire string to a new Surface, wrapping text to fit a specified width, using solid color blending. Requires a Font, text string, length, foreground color, and wrap width.

```odin
RenderText_Solid_Wrapped :: proc "c" (font: ^Font, text: cstring, length: uint, fg: sdl3.Color, wrap_width: i32) -> ^sdl3.Surface ---
```

--------------------------------

### Get Frame from Animation Decoder

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Retrieves the next frame and its duration from an animation decoder. Returns false if there are no more frames or an error occurs.

```odin
GetAnimationDecoderFrame :: proc "c" (decoder: ^AnimationDecoder, frame: ^^sdl3.Surface, duration: ^u64) -> bool ---
```

--------------------------------

### AnimationDecoder Struct Definition

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Represents an animation decoder. Used in procedures for closing, getting frames, properties, status, and resetting the decoder.

```odin
AnimationDecoder :: struct {}
```

--------------------------------

### Font Opening Procedures

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Procedures for opening font files, with options for direct file access or using properties.

```APIDOC
## Font Opening Procedures

### Description
Procedures to open font resources.

### Procedures
* OpenFont
* OpenFontIO
* OpenFontWithProperties
```

--------------------------------

### Load XPM Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an XPM image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadXPM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Glyph Kerning Adjustment

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the kerning adjustment value between two consecutive characters. Returns true if kerning data is available.

```odin
GetGlyphKerning :: proc "c" (font: ^Font, previous_ch: u32, ch: u32, kerning: ^i32) -> bool ---
```

--------------------------------

### Set Font Hinting

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Configures the hinting mode for a font.

```odin
SetFontHinting :: proc "c" (font: ^Font, hinting: Hinting) ---
```

--------------------------------

### Get Previous Text Substring

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the previous substring from a Text object, moving backward from the current position. Returns false if there are no preceding substrings.

```odin
GetPreviousTextSubString :: proc "c" (text: ^Text, #by_ptr substring: SubString, previous: ^SubString) -> bool ---
```

--------------------------------

### OpenFont

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Opens a font from a file path.

```APIDOC
## OpenFont

### Description
Opens a font from a specified file path with a given point size.

### Method
Call

### Parameters
- **file** (cstring) - The path to the font file (e.g., TTF, OTF).
- **ptsize** (f32) - The desired point size of the font.

### Return Value
- **^Font** - A pointer to the opened Font object, or nil if an error occurred.
```

--------------------------------

### Load PNM Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PNM image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadPNM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Text Color (f32)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the RGBA color components of a Text object as 32-bit floating-point numbers. Returns false if the retrieval fails.

```odin
GetTextColorFloat :: proc "c" (text: ^Text, r, g, b, a: ^f32) -> bool ---
```

--------------------------------

### Load Animation from File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an animation from a file path. This is a general function for loading animation data.

```odin
LoadAnimation :: proc "c" (file: cstring) -> ^Animation ---
```

--------------------------------

### Get Text Color (u8)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the RGBA color components of a Text object as unsigned 8-bit integers. Returns false if the retrieval fails.

```odin
GetTextColor :: proc "c" (text: ^Text, r, g, b, a: ^u8) -> bool ---
```

--------------------------------

### CreateRendererTextEngine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine associated with an SDL3 renderer. This is useful for rendering text directly to the screen using the active renderer.

```APIDOC
## CreateRendererTextEngine

### Description
Creates a text engine associated with an SDL3 renderer.

### Method
Call

### Parameters
#### Path Parameters
- **renderer** (^sdl3.Renderer) - Required - The SDL3 renderer to associate with the text engine.

### Response
#### Success Response
- **TextEngine** (^TextEngine) - A pointer to the newly created TextEngine.
```

--------------------------------

### LoadTGA_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a TGA image from an SDL3 IOStream.

```APIDOC
## LoadTGA_IO

### Description
Loads a TGA image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Get Text Substring for Line

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves a substring corresponding to a specific line number within a Text object. Returns false if the line number is invalid.

```odin
GetTextSubStringForLine :: proc "c" (text: ^Text, line: i32, substring: ^SubString) -> bool ---
```

--------------------------------

### Load GPU Texture from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image from an SDL3 IOStream directly into a GPU texture. Requires a GPUDevice and GPUCopyPass. Also returns the width and height.

```odin
LoadGPUTexture_IO :: proc "c" (
	device:    ^sdl3.GPUDevice, 
	copy_pass: ^sdl3.GPUCopyPass, 
	src:       ^sdl3.IOStream, 
	closeio:   bool, 
	width:     ^i32, 
	height:    ^i32, 
) -> ^sdl3.GPUTexture ---
```

--------------------------------

### Get Font Style Name

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the style name of the font (e.g., "Regular", "Bold Italic") as a C-style string.

```odin
GetFontStyleName :: proc "c" (font: ^Font) -> cstring ---
```

--------------------------------

### Get Text Substring for Point

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves the substring that contains the specified point (x, y) within a Text object. Returns false if the point is outside the text bounds.

```odin
GetTextSubStringForPoint :: proc "c" (text: ^Text, x, y: i32, substring: ^SubString) -> bool ---
```

--------------------------------

### Load LBM Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an LBM image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadLBM_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Get Text Substrings for Range

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Retrieves an array of substrings that fall within a specified range (offset and length) of a Text object. Returns a pointer to an array of SubString pointers.

```odin
GetTextSubStringsForRange :: proc "c" (text: ^Text, offset, length: i32, count: ^i32) -> [^]^SubString ---
```

--------------------------------

### Create Animated Cursor

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Creates an animated cursor from an Animation object. Requires specifying the hot-spot coordinates.

```odin
CreateAnimatedCursor :: proc "c" (anim: ^Animation, hot_x: i32, hot_y: i32) -> ^sdl3.Cursor ---
```

--------------------------------

### LoadJXL_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a JXL image from an SDL3 IOStream.

```APIDOC
## LoadJXL_IO

### Description
Loads a JXL image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Render Text Wrapped (LCD)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders an entire string to a new Surface, wrapping text to fit a specified width, using LCD sub-pixel rendering. Requires a Font, text string, length, foreground/background colors, and wrap width.

```odin
RenderText_LCD_Wrapped :: proc "c" (
	font:       ^Font,
	text:       cstring,
	length:     uint,
	fg, bg:     sdl3.Color,
	wrap_width: i32,
) -> ^sdl3.Surface ---
```

--------------------------------

### Save AVIF Image with Quality

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves an AVIF image to a file with a specified quality level. Returns a boolean indicating success. Requires the SDL3 library.

```odin
SaveAVIF :: proc "c" (surface: ^sdl3.Surface, file: cstring, quality: i32) -> bool ---
```

--------------------------------

### Load XCF Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an XCF image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadXCF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Save WEBP Image to File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves a surface as a WEBP image to a specified file path with a given quality setting.

```odin
SaveWEBP :: proc "c" (surface: ^sdl3.Surface, file: cstring, quality: f32) -> bool ---
```

--------------------------------

### Metadata Creation Time Property

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Constant for setting the creation time metadata for an image.

```odin
PROP_METADATA_CREATION_TIME_STRING :: "SDL_image.metadata.creation_time"
```

--------------------------------

### Save

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves a surface to a file.

```APIDOC
## Save

### Description
Saves a surface to a file. Individual saving functions are also available for specific formats.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (bool) - True if the save operation was successful, false otherwise.

#### Response Example
None
```

--------------------------------

### Save AVIF Image to IO Stream with Quality

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves an AVIF image to an SDL IOStream with a specified quality level. Allows control over closing the IO stream. Requires the SDL3 library.

```odin
SaveAVIF_IO :: proc "c" (surface: ^sdl3.Surface, dst: ^sdl3.IOStream, closeio: bool, quality: i32) -> bool ---
```

--------------------------------

### Save

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves an SDL_Surface to a file. The format is determined by the file extension.

```APIDOC
## Save

### Description
Saves an SDL_Surface to a file.

### Parameters
* **surface** (Pointer to sdl3.Surface) - A pointer to the SDL_Surface to save.
* **file** (String) - The path to the file where the image will be saved.

### Returns
* (i32) - Returns 0 on success or a negative error code on failure.
```

--------------------------------

### Load JXL Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a JXL image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadJXL_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### SetFontHinting

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Configures the hinting method for font rendering.

```APIDOC
## SetFontHinting

### Description
Configures the hinting method for font rendering.

### Signature
```
SetFontHinting :: proc "c" (font: ^Font, hinting: Hinting)
```
```

--------------------------------

### Load AVIF Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an AVIF image from an SDL3 IOStream and returns it as an SDL3 Surface. This function is specific to the AVIF image format.

```odin
LoadAVIF_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### RenderText_Solid_Wrapped

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders solid text with wrapping support. It takes a font, text, foreground color, and a wrap length, returning a Surface object.

```APIDOC
## RenderText_Solid_Wrapped

### Description
Renders solid text with wrapping support. It takes a font, text, foreground color, and a wrap length, returning a Surface object.

### Signature
```
RenderText_Solid_Wrapped :: proc "c" (font: ^Font, text: cstring, length: uint, fg: sdl3.Color, wrap_Length: i32) -> ^sdl3.Surface
```
```

--------------------------------

### Load TGA Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a TGA image from an SDL IOStream. Requires the SDL3 library.

```odin
LoadTGA_IO :: proc "c" (src: ^sdl3.IOStream) -> ^sdl3.Surface ---
```

--------------------------------

### Render Text (LCD)

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders an entire string to a new Surface using LCD sub-pixel rendering. Requires a Font, text string, length, and foreground/background colors.

```odin
RenderText_LCD :: proc "c" (font: ^Font, text: cstring, length: uint, fg, bg: sdl3.Color) -> ^sdl3.Surface ---
```

--------------------------------

### Set Font Size with DPI

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Sets the point size and DPI for a font. Returns a boolean indicating success.

```odin
SetFontSizeDPI :: proc "c" (font: ^Font, ptsize: f32, hdpi: i32, vdpi: i32) -> bool ---
```

--------------------------------

### CreateSurfaceTextEngine

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text engine that can render text to an SDL3 surface. This is suitable for off-screen rendering or image manipulation.

```APIDOC
## CreateSurfaceTextEngine

### Description
Creates a text engine that can render text to an SDL3 surface.

### Method
Call

### Response
#### Success Response
- **TextEngine** (^TextEngine) - A pointer to the newly created TextEngine.
```

--------------------------------

### Render Wrapped Text

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Renders text that wraps at a specified length, using a given font, text content, and foreground color. Returns a pointer to an SDL_Surface.

```odin
RenderText_Solid_Wrapped :: proc "c" (font: ^Font, text: cstring, length: uint, fg: sdl3.Color, wrap_Length: i32) -> ^sdl3.Surface ---
```

--------------------------------

### LoadBMP_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a BMP image from an IOStream. This procedure is specifically for the BMP image format.

```APIDOC
## LoadBMP_IO

### Description
Loads a BMP image from an IOStream.

### Method
`LoadBMP_IO`

### Parameters
#### Path Parameters
- **src** (`^sdl3.IOStream`) - The IOStream to read the BMP image data from.

### Return Value
- **^sdl3.Surface** - A pointer to the loaded `sdl3.Surface`.
```

--------------------------------

### WasInit

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Checks if the TTF library has been initialized. Returns an integer (typically 1 for true, 0 for false).

```APIDOC
## WasInit

### Description
Checks if the TTF library has been initialized. Returns an integer (typically 1 for true, 0 for false).

### Signature
```
WasInit :: proc "c" () -> i32
```
```

--------------------------------

### PROP_FONT_CREATE_EXISTING_FONT Constant

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Property constant for creating a font from an existing font.

```odin
PROP_FONT_CREATE_EXISTING_FONT :: "SDL_ttf.font.create.existing_font"
```

--------------------------------

### Detect QOI File Type

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Checks if the provided IOStream contains a QOI (Quite OK Image Format) image file.

```odin
isQOI :: proc "c" (src: ^sdl3.IOStream) -> bool ---
```

--------------------------------

### Load_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image from an IO stream into an SDL_Surface. This allows loading images from memory or other stream sources.

```APIDOC
## Load_IO

### Description
Loads an image from an IO stream into an SDL_Surface.

### Parameters
* **io** (Pointer to sdl3.IOStream) - The IO stream to read the image data from.

### Returns
* (Pointer to sdl3.Surface) - A pointer to the loaded SDL_Surface, or nil on failure.
```

--------------------------------

### Create Text Object

Source: https://pkg.odin-lang.org/vendor/sdl3/ttf

Creates a text object from a given text engine, font, and string. Requires the text engine, font, text string, and its length.

```odin
CreateText :: proc "c" (engine: ^TextEngine, font: ^Font, text: cstring, length: uint) -> ^Text ---
```

--------------------------------

### LoadPNM_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads a PNM image from an SDL3 IOStream.

```APIDOC
## LoadPNM_IO

### Description
Loads a PNM image from an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (^sdl3.Surface) - A pointer to the loaded SDL3 Surface.

#### Response Example
None
```

--------------------------------

### Save JPG Image to File

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves a surface as a JPG image to a specified file path with a given quality setting.

```odin
SaveJPG :: proc "c" (surface: ^sdl3.Surface, file: cstring, quality: i32) -> bool ---
```

--------------------------------

### Load GPU Texture from IO Stream with Type

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image from an SDL3 IOStream directly into a GPU texture, specifying the image type. Requires a GPUDevice and GPUCopyPass. Also returns the width and height.

```odin
LoadGPUTextureTyped_IO :: proc "c" (
	device:    ^sdl3.GPUDevice, 
	copy_pass: ^sdl3.GPUCopyPass, 
	src:       ^sdl3.IOStream, 
	closeio:   bool, 
	type:      cstring, 
	width:     ^i32, 
	height:    ^i32, 
) -> ^sdl3.GPUTexture ---
```

--------------------------------

### Load Texture from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an image into a render texture from an SDL IOStream. Allows control over closing the IO stream. Requires the SDL3 library.

```odin
LoadTexture_IO :: proc "c" (renderer: ^sdl3.Renderer, src: ^sdl3.IOStream, closeio: bool) -> ^sdl3.Texture ---
```

--------------------------------

### SaveBMP_IO

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Saves a surface in BMP format to an SDL3 IOStream.

```APIDOC
## SaveBMP_IO

### Description
Saves a surface in BMP format to an SDL3 IOStream.

### Method
Not specified (assumed to be a function call).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **return value** (bool) - True if the save operation was successful, false otherwise.

#### Response Example
None
```

--------------------------------

### Load Sized SVG Image from IO Stream

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Loads an SVG image from an SDL IOStream with specified width and height. Requires the SDL3 library.

```odin
LoadSizedSVG_IO :: proc "c" (src: ^sdl3.IOStream, width, height: i32) -> ^sdl3.Surface ---
```

--------------------------------

### Decoder Create Filename Property

Source: https://pkg.odin-lang.org/vendor/sdl3/image

Constant for specifying the filename when creating an animation decoder.

```odin
PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING :: "SDL_image.animation_decoder.create.filename"
```
Tokens:
Raw