Bindings for [[ SDL3 Image ; https://wiki.libsdl.org/SDL3_image/FrontPage ]].

Collection Info

View Source
Collection
vendor
Path
sdl3/image
Entries
138

Source Files

Constants

32

PROP_ANIMATION_DECODER_CREATE_AVIF_ALLOW_INCREMENTAL_BOOLEAN #

Source
PROP_ANIMATION_DECODER_CREATE_AVIF_ALLOW_INCREMENTAL_BOOLEAN :: "SDL_image.animation_decoder.create.avif.allow_incremental"

PROP_ANIMATION_DECODER_CREATE_AVIF_ALLOW_PROGRESSIVE_BOOLEAN #

Source
PROP_ANIMATION_DECODER_CREATE_AVIF_ALLOW_PROGRESSIVE_BOOLEAN :: "SDL_image.animation_decoder.create.avif.allow_progressive"

PROP_ANIMATION_DECODER_CREATE_AVIF_MAX_THREADS_NUMBER #

Source
PROP_ANIMATION_DECODER_CREATE_AVIF_MAX_THREADS_NUMBER :: "SDL_image.animation_decoder.create.avif.max_threads"

PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING #

Source
PROP_ANIMATION_DECODER_CREATE_FILENAME_STRING :: "SDL_image.animation_decoder.create.filename"

PROP_ANIMATION_DECODER_CREATE_GIF_NUM_COLORS_NUMBER #

Source
PROP_ANIMATION_DECODER_CREATE_GIF_NUM_COLORS_NUMBER :: "SDL_image.animation_encoder.create.gif.num_colors"

PROP_ANIMATION_DECODER_CREATE_GIF_TRANSPARENT_COLOR_INDEX_NUMBER #

Source
PROP_ANIMATION_DECODER_CREATE_GIF_TRANSPARENT_COLOR_INDEX_NUMBER :: "SDL_image.animation_encoder.create.gif.transparent_color_index"

PROP_ANIMATION_DECODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN #

Source
PROP_ANIMATION_DECODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN :: "SDL_image.animation_decoder.create.iostream.autoclose"

PROP_ANIMATION_DECODER_CREATE_IOSTREAM_POINTER #

Source
PROP_ANIMATION_DECODER_CREATE_IOSTREAM_POINTER :: "SDL_image.animation_decoder.create.iostream"

PROP_ANIMATION_DECODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER #

Source
PROP_ANIMATION_DECODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER :: "SDL_image.animation_decoder.create.timebase.denominator"

PROP_ANIMATION_DECODER_CREATE_TIMEBASE_NUMERATOR_NUMBER #

Source
PROP_ANIMATION_DECODER_CREATE_TIMEBASE_NUMERATOR_NUMBER :: "SDL_image.animation_decoder.create.timebase.numerator"

PROP_ANIMATION_DECODER_CREATE_TYPE_STRING #

Source
PROP_ANIMATION_DECODER_CREATE_TYPE_STRING :: "SDL_image.animation_decoder.create.type"

PROP_ANIMATION_ENCODER_CREATE_AVIF_KEYFRAME_INTERVAL_NUMBER #

Source
PROP_ANIMATION_ENCODER_CREATE_AVIF_KEYFRAME_INTERVAL_NUMBER :: "SDL_image.animation_encoder.create.avif.keyframe_interval"

PROP_ANIMATION_ENCODER_CREATE_AVIF_MAX_THREADS_NUMBER #

Source
PROP_ANIMATION_ENCODER_CREATE_AVIF_MAX_THREADS_NUMBER :: "SDL_image.animation_encoder.create.avif.max_threads"

PROP_ANIMATION_ENCODER_CREATE_FILENAME_STRING #

Source
PROP_ANIMATION_ENCODER_CREATE_FILENAME_STRING :: "SDL_image.animation_encoder.create.filename"

PROP_ANIMATION_ENCODER_CREATE_GIF_USE_LUT_BOOLEAN #

Source
PROP_ANIMATION_ENCODER_CREATE_GIF_USE_LUT_BOOLEAN :: "SDL_image.animation_encoder.create.gif.use_lut"

PROP_ANIMATION_ENCODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN #

Source
PROP_ANIMATION_ENCODER_CREATE_IOSTREAM_AUTOCLOSE_BOOLEAN :: "SDL_image.animation_encoder.create.iostream.autoclose"

PROP_ANIMATION_ENCODER_CREATE_IOSTREAM_POINTER #

Source
PROP_ANIMATION_ENCODER_CREATE_IOSTREAM_POINTER :: "SDL_image.animation_encoder.create.iostream"

PROP_ANIMATION_ENCODER_CREATE_QUALITY_NUMBER #

Source
PROP_ANIMATION_ENCODER_CREATE_QUALITY_NUMBER :: "SDL_image.animation_encoder.create.quality"

PROP_ANIMATION_ENCODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER #

Source
PROP_ANIMATION_ENCODER_CREATE_TIMEBASE_DENOMINATOR_NUMBER :: "SDL_image.animation_encoder.create.timebase.denominator"

PROP_ANIMATION_ENCODER_CREATE_TIMEBASE_NUMERATOR_NUMBER #

Source
PROP_ANIMATION_ENCODER_CREATE_TIMEBASE_NUMERATOR_NUMBER :: "SDL_image.animation_encoder.create.timebase.numerator"

PROP_ANIMATION_ENCODER_CREATE_TYPE_STRING #

Source
PROP_ANIMATION_ENCODER_CREATE_TYPE_STRING :: "SDL_image.animation_encoder.create.type"

PROP_METADATA_AUTHOR_STRING #

Source
PROP_METADATA_AUTHOR_STRING :: "SDL_image.metadata.author"

PROP_METADATA_COPYRIGHT_STRING #

Source
PROP_METADATA_COPYRIGHT_STRING :: "SDL_image.metadata.copyright"

PROP_METADATA_CREATION_TIME_STRING #

Source
PROP_METADATA_CREATION_TIME_STRING :: "SDL_image.metadata.creation_time"

PROP_METADATA_DESCRIPTION_STRING #

Source
PROP_METADATA_DESCRIPTION_STRING :: "SDL_image.metadata.description"

PROP_METADATA_FRAME_COUNT_NUMBER #

Source
PROP_METADATA_FRAME_COUNT_NUMBER :: "SDL_image.metadata.frame_count"

PROP_METADATA_IGNORE_PROPS_BOOLEAN #

Source
PROP_METADATA_IGNORE_PROPS_BOOLEAN :: "SDL_image.metadata.ignore_props"

PROP_METADATA_LOOP_COUNT_NUMBER #

Source
PROP_METADATA_LOOP_COUNT_NUMBER :: "SDL_image.metadata.loop_count"

PROP_METADATA_TITLE_STRING #

Source
PROP_METADATA_TITLE_STRING :: "SDL_image.metadata.title"

Types

4

Procedures

102

GetClipboardImage #

Source
GetClipboardImage :: proc "c" () -> ^Surface ---

Get the image currently in the clipboard.

LoadTyped_IO #

Source
LoadTyped_IO :: proc "c" (src: ^IOStream, closeio: bool, type: cstring) -> ^Surface ---

Load an image from an SDL data source. The 'type' may be one of: "BMP", "GIF", "PNG", etc. If the image format supports a transparent pixel, SDL will set the colorkey for the surface. You can enable RLE acceleration on the surface afterwards by calling: SDL_SetColorKey(image, SDL_RLEACCEL, image->format->colorkey);