Get the number of 2D rendering drivers available for the current display.

A render driver is a set of code that handles rendering and texture management on a particular display. Normally there is only one, but some drivers may have several available with different capabilities.

There may be none if SDL was compiled without render support.

Returns

the number of built in render drivers.

Thread safety

It is safe to call this function from any thread.

See also

createRenderer, getRenderDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Get the number of 2D rendering drivers available for the current display.

A render driver is a set of code that handles rendering and texture management on a particular display. Normally there is only one, but some drivers may have several available with different capabilities.

There may be none if SDL was compiled without render support.

Returns

the number of built in render drivers.

Thread safety

It is safe to call this function from any thread.

See also

createRenderer, getRenderDriver

sdl3-bindgen-sys notes

Since: 3.2.0

Use this function to get the name of a built in 2D rendering driver.

The list of rendering drivers is given in the order that they are normally initialized by default; the drivers that seem more reasonable to choose first (as far as the SDL developers believe) are earlier in the list.

The names of drivers are all simple, low-ASCII identifiers, like "opengl", "direct3d12" or "metal". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the rendering driver at the requested index, or NULL if an invalid index was specified.

Thread safety

It is safe to call this function from any thread.

See also

getNumRenderDrivers

sdl3-bindgen-sys notes

Since: 3.2.0

Use this function to get the name of a built in 2D rendering driver.

The list of rendering drivers is given in the order that they are normally initialized by default; the drivers that seem more reasonable to choose first (as far as the SDL developers believe) are earlier in the list.

The names of drivers are all simple, low-ASCII identifiers, like "opengl", "direct3d12" or "metal". These never have Unicode characters, and are not meant to be proper names.

Returns

the name of the rendering driver at the requested index, or NULL if an invalid index was specified.

Thread safety

It is safe to call this function from any thread.

See also

getNumRenderDrivers

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window and default renderer.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createRenderer, createWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Create a window and default renderer.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createRenderer, createWindow

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D rendering context for a window.

If you want a specific renderer, you can specify its name here. A list of available renderers can be obtained by calling getRenderDriver multiple times, with indices from 0 to getNumRenderDrivers -1. If you don't need a specific renderer, specify NULL and SDL will attempt to choose the best option for you, based on what is available on the user's system.

If name is a comma-separated list, SDL will try each name, in the order listed, until one succeeds or all of them fail.

By default the rendering size matches the window size in pixels, but you can call setRenderLogicalPresentation to change the content size and scaling options.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createRendererWithProperties, createSoftwareRenderer, destroyRenderer, getNumRenderDrivers, getRenderDriver, getRendererName

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D rendering context for a window.

If you want a specific renderer, you can specify its name here. A list of available renderers can be obtained by calling getRenderDriver multiple times, with indices from 0 to getNumRenderDrivers -1. If you don't need a specific renderer, specify NULL and SDL will attempt to choose the best option for you, based on what is available on the user's system.

If name is a comma-separated list, SDL will try each name, in the order listed, until one succeeds or all of them fail.

By default the rendering size matches the window size in pixels, but you can call setRenderLogicalPresentation to change the content size and scaling options.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createRendererWithProperties, createSoftwareRenderer, destroyRenderer, getNumRenderDrivers, getRenderDriver, getRendererName

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D rendering context for a window, with the specified properties.

These are the supported properties:

• sDL_PROP_RENDERER_CREATE_NAME_STRING: the name of the rendering driver to use, if a specific one is desired
• sDL_PROP_RENDERER_CREATE_WINDOW_POINTER: the window where rendering is displayed, required if this isn't a software renderer using a surface
• sDL_PROP_RENDERER_CREATE_SURFACE_POINTER: the surface where rendering is displayed, if you want a software renderer without a window
• sDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER: an SDL_Colorspace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB. The direct3d11, direct3d12, and metal renderers support SDL_COLORSPACE_SRGB_LINEAR, which is a linear color space and supports HDR output. If you select SDL_COLORSPACE_SRGB_LINEAR, drawing still uses the sRGB colorspace, but values can go beyond 1.0 and float (linear) format textures can be used for HDR content.
• sDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER: non-zero if you want present synchronized with the refresh rate. This property can take any value that is supported by setRenderVSync for the renderer.

With the SDL GPU renderer (since SDL 3.4.0):

• sDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER: the device to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN: the app is able to provide SPIR-V shaders to SDL_GPURenderState, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN: the app is able to provide DXIL shaders to SDL_GPURenderState, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN: the app is able to provide MSL shaders to SDL_GPURenderState, optional.

With the vulkan renderer:

• sDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER: the VkInstance to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER: the VkSurfaceKHR to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER: the VkPhysicalDevice to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER: the VkDevice to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for rendering.
• sDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for presentation.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createRenderer, createSoftwareRenderer, destroyRenderer, getRendererName

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D rendering context for a window, with the specified properties.

These are the supported properties:

• sDL_PROP_RENDERER_CREATE_NAME_STRING: the name of the rendering driver to use, if a specific one is desired
• sDL_PROP_RENDERER_CREATE_WINDOW_POINTER: the window where rendering is displayed, required if this isn't a software renderer using a surface
• sDL_PROP_RENDERER_CREATE_SURFACE_POINTER: the surface where rendering is displayed, if you want a software renderer without a window
• sDL_PROP_RENDERER_CREATE_OUTPUT_COLORSPACE_NUMBER: an SDL_Colorspace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB. The direct3d11, direct3d12, and metal renderers support SDL_COLORSPACE_SRGB_LINEAR, which is a linear color space and supports HDR output. If you select SDL_COLORSPACE_SRGB_LINEAR, drawing still uses the sRGB colorspace, but values can go beyond 1.0 and float (linear) format textures can be used for HDR content.
• sDL_PROP_RENDERER_CREATE_PRESENT_VSYNC_NUMBER: non-zero if you want present synchronized with the refresh rate. This property can take any value that is supported by setRenderVSync for the renderer.

With the SDL GPU renderer (since SDL 3.4.0):

• sDL_PROP_RENDERER_CREATE_GPU_DEVICE_POINTER: the device to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN: the app is able to provide SPIR-V shaders to SDL_GPURenderState, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN: the app is able to provide DXIL shaders to SDL_GPURenderState, optional.
• sDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN: the app is able to provide MSL shaders to SDL_GPURenderState, optional.

With the vulkan renderer:

• sDL_PROP_RENDERER_CREATE_VULKAN_INSTANCE_POINTER: the VkInstance to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_SURFACE_NUMBER: the VkSurfaceKHR to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_PHYSICAL_DEVICE_POINTER: the VkPhysicalDevice to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_DEVICE_POINTER: the VkDevice to use with the renderer, optional.
• sDL_PROP_RENDERER_CREATE_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for rendering.
• sDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for presentation.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createRenderer, createSoftwareRenderer, destroyRenderer, getRendererName

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D GPU rendering context.

The GPU device to use is passed in as a parameter. If this is NULL, then a device will be created normally and can be retrieved using getGPURendererDevice.

The window to use is passed in as a parameter. If this is NULL, then this will become an offscreen renderer. In that case, you should call setRenderTarget to setup rendering to a texture, and then call renderPresent normally to complete drawing a frame.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

If this function is called with a valid GPU device, it should be called on the thread that created the device. If this function is called with a valid window, it should be called on the thread that created the window.

See also

createRendererWithProperties, getGPURendererDevice, createGPUShader, createGPURenderState, setGPURenderState

sdl3-bindgen-sys notes

Since: 3.4.0

Create a 2D GPU rendering context.

The GPU device to use is passed in as a parameter. If this is NULL, then a device will be created normally and can be retrieved using getGPURendererDevice.

The window to use is passed in as a parameter. If this is NULL, then this will become an offscreen renderer. In that case, you should call setRenderTarget to setup rendering to a texture, and then call renderPresent normally to complete drawing a frame.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

If this function is called with a valid GPU device, it should be called on the thread that created the device. If this function is called with a valid window, it should be called on the thread that created the window.

See also

createRendererWithProperties, getGPURendererDevice, createGPUShader, createGPURenderState, setGPURenderState

sdl3-bindgen-sys notes

Since: 3.4.0

Return the GPU device used by a renderer.

Returns

the GPU device used by the renderer, or NULL if the renderer is not a GPU renderer; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.4.0

Return the GPU device used by a renderer.

Returns

the GPU device used by the renderer, or NULL if the renderer is not a GPU renderer; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.4.0

Create a 2D software rendering context for a surface.

Two other APIs which can be used to create SDL_Renderer: createRenderer and createWindowAndRenderer. These can also create a software renderer, but they are intended to be used with an SDL_Window as the final destination and not an SDL_Surface.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

It is safe to call this function from any thread.

See also

destroyRenderer

sdl3-bindgen-sys notes

Since: 3.2.0

Create a 2D software rendering context for a surface.

Two other APIs which can be used to create SDL_Renderer: createRenderer and createWindowAndRenderer. These can also create a software renderer, but they are intended to be used with an SDL_Window as the final destination and not an SDL_Surface.

Returns

a valid rendering context or NULL if there was an error; call getError for more information.

Thread safety

It is safe to call this function from any thread.

See also

destroyRenderer

sdl3-bindgen-sys notes

Since: 3.2.0

Get the renderer associated with a window.

Returns

the rendering context on success or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the renderer associated with a window.

Returns

the rendering context on success or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the window associated with a renderer.

Returns

the window on success or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the window associated with a renderer.

Returns

the window on success or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a renderer.

Returns

the name of the selected renderer, or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

See also

createRenderer, createRendererWithProperties

sdl3-bindgen-sys notes

Since: 3.2.0

Get the name of a renderer.

Returns

the name of the selected renderer, or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

See also

createRenderer, createRendererWithProperties

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a renderer.

The following read-only properties are provided by SDL:

• sDL_PROP_RENDERER_NAME_STRING: the name of the rendering driver
• sDL_PROP_RENDERER_WINDOW_POINTER: the window where rendering is displayed, if any
• sDL_PROP_RENDERER_SURFACE_POINTER: the surface where rendering is displayed, if this is a software renderer without a window
• sDL_PROP_RENDERER_VSYNC_NUMBER: the current vsync setting
• sDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER: the maximum texture width and height
• sDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER: a (const SDL_PixelFormat *) array of pixel formats, terminated with SDL_PIXELFORMAT_UNKNOWN, representing the available texture formats for this renderer.
• sDL_PROP_RENDERER_TEXTURE_WRAPPING_BOOLEAN: true if the renderer supports SDL_TEXTURE_ADDRESS_WRAP on non-power-of-two textures.
• sDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER: an SDL_Colorspace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB.
• sDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN: true if the output colorspace is SDL_COLORSPACE_SRGB_LINEAR and the renderer is showing on a display with HDR enabled. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT: the value of SDR white in the SDL_COLORSPACE_SRGB_LINEAR colorspace. When HDR is enabled, this value is automatically multiplied into the color scale. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_RENDERER_HDR_HEADROOM_FLOAT: the additional high dynamic range that can be displayed, in terms of the SDR white point. When HDR is not enabled, this will be 1.0. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.

With the direct3d renderer:

• sDL_PROP_RENDERER_D3D9_DEVICE_POINTER: the IDirect3DDevice9 associated with the renderer

With the direct3d11 renderer:

• sDL_PROP_RENDERER_D3D11_DEVICE_POINTER: the ID3D11Device associated with the renderer
• sDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER: the IDXGISwapChain1 associated with the renderer. This may change when the window is resized.

With the direct3d12 renderer:

• sDL_PROP_RENDERER_D3D12_DEVICE_POINTER: the ID3D12Device associated with the renderer
• sDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER: the IDXGISwapChain4 associated with the renderer.
• sDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER: the ID3D12CommandQueue associated with the renderer

With the vulkan renderer:

• sDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER: the VkInstance associated with the renderer
• sDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER: the VkSurfaceKHR associated with the renderer
• sDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER: the VkPhysicalDevice associated with the renderer
• sDL_PROP_RENDERER_VULKAN_DEVICE_POINTER: the VkDevice associated with the renderer
• sDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for rendering
• sDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for presentation
• sDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER: the number of swapchain images, or potential frames in flight, used by the Vulkan renderer

With the gpu renderer:

• sDL_PROP_RENDERER_GPU_DEVICE_POINTER: the SDL_GPUDevice associated with the renderer

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a renderer.

The following read-only properties are provided by SDL:

• sDL_PROP_RENDERER_NAME_STRING: the name of the rendering driver
• sDL_PROP_RENDERER_WINDOW_POINTER: the window where rendering is displayed, if any
• sDL_PROP_RENDERER_SURFACE_POINTER: the surface where rendering is displayed, if this is a software renderer without a window
• sDL_PROP_RENDERER_VSYNC_NUMBER: the current vsync setting
• sDL_PROP_RENDERER_MAX_TEXTURE_SIZE_NUMBER: the maximum texture width and height
• sDL_PROP_RENDERER_TEXTURE_FORMATS_POINTER: a (const SDL_PixelFormat *) array of pixel formats, terminated with SDL_PIXELFORMAT_UNKNOWN, representing the available texture formats for this renderer.
• sDL_PROP_RENDERER_TEXTURE_WRAPPING_BOOLEAN: true if the renderer supports SDL_TEXTURE_ADDRESS_WRAP on non-power-of-two textures.
• sDL_PROP_RENDERER_OUTPUT_COLORSPACE_NUMBER: an SDL_Colorspace value describing the colorspace for output to the display, defaults to SDL_COLORSPACE_SRGB.
• sDL_PROP_RENDERER_HDR_ENABLED_BOOLEAN: true if the output colorspace is SDL_COLORSPACE_SRGB_LINEAR and the renderer is showing on a display with HDR enabled. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_RENDERER_SDR_WHITE_POINT_FLOAT: the value of SDR white in the SDL_COLORSPACE_SRGB_LINEAR colorspace. When HDR is enabled, this value is automatically multiplied into the color scale. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.
• sDL_PROP_RENDERER_HDR_HEADROOM_FLOAT: the additional high dynamic range that can be displayed, in terms of the SDR white point. When HDR is not enabled, this will be 1.0. This property can change dynamically when SDL_EVENT_WINDOW_HDR_STATE_CHANGED is sent.

With the direct3d renderer:

• sDL_PROP_RENDERER_D3D9_DEVICE_POINTER: the IDirect3DDevice9 associated with the renderer

With the direct3d11 renderer:

• sDL_PROP_RENDERER_D3D11_DEVICE_POINTER: the ID3D11Device associated with the renderer
• sDL_PROP_RENDERER_D3D11_SWAPCHAIN_POINTER: the IDXGISwapChain1 associated with the renderer. This may change when the window is resized.

With the direct3d12 renderer:

• sDL_PROP_RENDERER_D3D12_DEVICE_POINTER: the ID3D12Device associated with the renderer
• sDL_PROP_RENDERER_D3D12_SWAPCHAIN_POINTER: the IDXGISwapChain4 associated with the renderer.
• sDL_PROP_RENDERER_D3D12_COMMAND_QUEUE_POINTER: the ID3D12CommandQueue associated with the renderer

With the vulkan renderer:

• sDL_PROP_RENDERER_VULKAN_INSTANCE_POINTER: the VkInstance associated with the renderer
• sDL_PROP_RENDERER_VULKAN_SURFACE_NUMBER: the VkSurfaceKHR associated with the renderer
• sDL_PROP_RENDERER_VULKAN_PHYSICAL_DEVICE_POINTER: the VkPhysicalDevice associated with the renderer
• sDL_PROP_RENDERER_VULKAN_DEVICE_POINTER: the VkDevice associated with the renderer
• sDL_PROP_RENDERER_VULKAN_GRAPHICS_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for rendering
• sDL_PROP_RENDERER_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER: the queue family index used for presentation
• sDL_PROP_RENDERER_VULKAN_SWAPCHAIN_IMAGE_COUNT_NUMBER: the number of swapchain images, or potential frames in flight, used by the Vulkan renderer

With the gpu renderer:

• sDL_PROP_RENDERER_GPU_DEVICE_POINTER: the SDL_GPUDevice associated with the renderer

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the output size in pixels of a rendering context.

This returns the true output size in pixels, ignoring any render targets or logical size and presentation.

For the output size of the current rendering target, with logical size adjustments, use getCurrentRenderOutputSize instead.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getCurrentRenderOutputSize

sdl3-bindgen-sys notes

Since: 3.2.0

Get the output size in pixels of a rendering context.

This returns the true output size in pixels, ignoring any render targets or logical size and presentation.

For the output size of the current rendering target, with logical size adjustments, use getCurrentRenderOutputSize instead.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getCurrentRenderOutputSize

sdl3-bindgen-sys notes

Since: 3.2.0

Get the current output size in pixels of a rendering context.

If a rendering target is active, this will return the size of the rendering target in pixels, otherwise return the value of getRenderOutputSize.

Rendering target or not, the output will be adjusted by the current logical presentation state, dictated by setRenderLogicalPresentation.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getRenderOutputSize

sdl3-bindgen-sys notes

Since: 3.2.0

Get the current output size in pixels of a rendering context.

If a rendering target is active, this will return the size of the rendering target in pixels, otherwise return the value of getRenderOutputSize.

Rendering target or not, the output will be adjusted by the current logical presentation state, dictated by setRenderLogicalPresentation.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getRenderOutputSize

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture for a rendering context.

The contents of a texture when first created are not defined.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createTextureFromSurface, createTextureWithProperties, destroyTexture, getTextureSize, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture for a rendering context.

The contents of a texture when first created are not defined.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createTextureFromSurface, createTextureWithProperties, destroyTexture, getTextureSize, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture from an existing surface.

The surface is not modified or freed by this function.

The SDL_TextureAccess hint for the created texture is SDL_TEXTUREACCESS_STATIC.

The pixel format of the created texture may be different from the pixel format of the surface, and can be queried using the SDL_PROP_TEXTURE_FORMAT_NUMBER property.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createTexture, createTextureWithProperties, destroyTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture from an existing surface.

The surface is not modified or freed by this function.

The SDL_TextureAccess hint for the created texture is SDL_TEXTUREACCESS_STATIC.

The pixel format of the created texture may be different from the pixel format of the surface, and can be queried using the SDL_PROP_TEXTURE_FORMAT_NUMBER property.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createTexture, createTextureWithProperties, destroyTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture for a rendering context with the specified properties.

These are the supported properties:

• sDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER: an SDL_Colorspace value describing the texture colorspace, defaults to SDL_COLORSPACE_SRGB_LINEAR for floating point textures, SDL_COLORSPACE_HDR10 for 10-bit textures, SDL_COLORSPACE_SRGB for other RGB textures and SDL_COLORSPACE_JPEG for YUV textures.
• sDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER: one of the enumerated values in SDL_PixelFormat, defaults to the best RGBA format for the renderer
• sDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER: one of the enumerated values in SDL_TextureAccess, defaults to SDL_TEXTUREACCESS_STATIC
• sDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER: the width of the texture in pixels, required
• sDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER: the height of the texture in pixels, required
• sDL_PROP_TEXTURE_CREATE_PALETTE_POINTER: an SDL_Palette to use with palettized texture formats. This can be set later with setTexturePalette
• sDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point textures, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for floating point textures.
• sDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT: for HDR10 and floating point textures, this defines the maximum dynamic range used by the content, in terms of the SDR white point. This would be equivalent to maxCLL / SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT for HDR10 content. If this is defined, any values outside the range supported by the display will be scaled into the available HDR headroom, otherwise they are clipped.

With the direct3d11 renderer:

• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER: the ID3D11Texture2D associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER: the ID3D11Texture2D associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER: the ID3D11Texture2D associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the direct3d12 renderer:

• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER: the ID3D12Resource associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER: the ID3D12Resource associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER: the ID3D12Resource associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the metal renderer:

• sDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER: the CVPixelBufferRef associated with the texture, if you want to create a texture from an existing pixel buffer.

With the opengl renderer:

• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER: the GLuint texture associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the opengles2 renderer:

• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER: the GLuint texture associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the vulkan renderer:

• sDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER: the VkImage associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_VULKAN_LAYOUT_NUMBER: the VkImageLayout for the VkImage, defaults to VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL.

With the GPU renderer:

• sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_POINTER: the SDL_GPUTexture associated with the texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_UV_NUMBER: the SDL_GPUTexture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_U_NUMBER: the SDL_GPUTexture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_V_NUMBER: the SDL_GPUTexture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createTexture, createTextureFromSurface, destroyTexture, getTextureSize, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Create a texture for a rendering context with the specified properties.

These are the supported properties:

• sDL_PROP_TEXTURE_CREATE_COLORSPACE_NUMBER: an SDL_Colorspace value describing the texture colorspace, defaults to SDL_COLORSPACE_SRGB_LINEAR for floating point textures, SDL_COLORSPACE_HDR10 for 10-bit textures, SDL_COLORSPACE_SRGB for other RGB textures and SDL_COLORSPACE_JPEG for YUV textures.
• sDL_PROP_TEXTURE_CREATE_FORMAT_NUMBER: one of the enumerated values in SDL_PixelFormat, defaults to the best RGBA format for the renderer
• sDL_PROP_TEXTURE_CREATE_ACCESS_NUMBER: one of the enumerated values in SDL_TextureAccess, defaults to SDL_TEXTUREACCESS_STATIC
• sDL_PROP_TEXTURE_CREATE_WIDTH_NUMBER: the width of the texture in pixels, required
• sDL_PROP_TEXTURE_CREATE_HEIGHT_NUMBER: the height of the texture in pixels, required
• sDL_PROP_TEXTURE_CREATE_PALETTE_POINTER: an SDL_Palette to use with palettized texture formats. This can be set later with setTexturePalette
• sDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point textures, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for floating point textures.
• sDL_PROP_TEXTURE_CREATE_HDR_HEADROOM_FLOAT: for HDR10 and floating point textures, this defines the maximum dynamic range used by the content, in terms of the SDR white point. This would be equivalent to maxCLL / SDL_PROP_TEXTURE_CREATE_SDR_WHITE_POINT_FLOAT for HDR10 content. If this is defined, any values outside the range supported by the display will be scaled into the available HDR headroom, otherwise they are clipped.

With the direct3d11 renderer:

• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_POINTER: the ID3D11Texture2D associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_U_POINTER: the ID3D11Texture2D associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D11_TEXTURE_V_POINTER: the ID3D11Texture2D associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the direct3d12 renderer:

• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_POINTER: the ID3D12Resource associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_U_POINTER: the ID3D12Resource associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_D3D12_TEXTURE_V_POINTER: the ID3D12Resource associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the metal renderer:

• sDL_PROP_TEXTURE_CREATE_METAL_PIXELBUFFER_POINTER: the CVPixelBufferRef associated with the texture, if you want to create a texture from an existing pixel buffer.

With the opengl renderer:

• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_NUMBER: the GLuint texture associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGL_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the opengles2 renderer:

• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_NUMBER: the GLuint texture associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_OPENGLES2_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

With the vulkan renderer:

• sDL_PROP_TEXTURE_CREATE_VULKAN_TEXTURE_NUMBER: the VkImage associated with the texture, if you want to wrap an existing texture.
• sDL_PROP_TEXTURE_CREATE_VULKAN_LAYOUT_NUMBER: the VkImageLayout for the VkImage, defaults to VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL.

With the GPU renderer:

• sDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_POINTER: the SDL_GPUTexture associated with the texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_UV_NUMBER: the SDL_GPUTexture associated with the UV plane of an NV12 texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_U_NUMBER: the SDL_GPUTexture associated with the U plane of a YUV texture, if you want to wrap an existing texture.
• SDL_PROP_TEXTURE_CREATE_GPU_TEXTURE_V_NUMBER: the SDL_GPUTexture associated with the V plane of a YUV texture, if you want to wrap an existing texture.

Returns

the created texture or NULL on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createProperties, createTexture, createTextureFromSurface, destroyTexture, getTextureSize, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a texture.

The following read-only properties are provided by SDL:

• sDL_PROP_TEXTURE_COLORSPACE_NUMBER: an SDL_Colorspace value describing the texture colorspace.
• sDL_PROP_TEXTURE_FORMAT_NUMBER: one of the enumerated values in SDL_PixelFormat.
• sDL_PROP_TEXTURE_ACCESS_NUMBER: one of the enumerated values in SDL_TextureAccess.
• sDL_PROP_TEXTURE_WIDTH_NUMBER: the width of the texture in pixels.
• sDL_PROP_TEXTURE_HEIGHT_NUMBER: the height of the texture in pixels.
• sDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point textures, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for other textures.
• sDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT: for HDR10 and floating point textures, this defines the maximum dynamic range used by the content, in terms of the SDR white point. If this is defined, any values outside the range supported by the display will be scaled into the available HDR headroom, otherwise they are clipped. This defaults to 1.0 for SDR textures, 4.0 for HDR10 textures, and no default for floating point textures.

With the direct3d11 renderer:

• sDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER: the ID3D11Texture2D associated with the texture
• sDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER: the ID3D11Texture2D associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER: the ID3D11Texture2D associated with the V plane of a YUV texture

With the direct3d12 renderer:

• sDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER: the ID3D12Resource associated with the texture
• sDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER: the ID3D12Resource associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER: the ID3D12Resource associated with the V plane of a YUV texture

With the vulkan renderer:

• sDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER: the VkImage associated with the texture

With the opengl renderer:

• sDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER: the GLuint texture associated with the texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER: the GLenum for the texture target (GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE_ARB, etc)
• sDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT: the texture coordinate width of the texture (0.0 - 1.0)
• sDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT: the texture coordinate height of the texture (0.0 - 1.0)

With the opengles2 renderer:

• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER: the GLuint texture associated with the texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER: the GLenum for the texture target (GL_TEXTURE_2D, GL_TEXTURE_EXTERNAL_OES, etc)

With the gpu renderer:

• sDL_PROP_TEXTURE_GPU_TEXTURE_POINTER: the SDL_GPUTexture associated with the texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_UV_POINTER: the SDL_GPUTexture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_U_POINTER: the SDL_GPUTexture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_V_POINTER: the SDL_GPUTexture associated with the V plane of a YUV texture

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the properties associated with a texture.

The following read-only properties are provided by SDL:

• sDL_PROP_TEXTURE_COLORSPACE_NUMBER: an SDL_Colorspace value describing the texture colorspace.
• sDL_PROP_TEXTURE_FORMAT_NUMBER: one of the enumerated values in SDL_PixelFormat.
• sDL_PROP_TEXTURE_ACCESS_NUMBER: one of the enumerated values in SDL_TextureAccess.
• sDL_PROP_TEXTURE_WIDTH_NUMBER: the width of the texture in pixels.
• sDL_PROP_TEXTURE_HEIGHT_NUMBER: the height of the texture in pixels.
• sDL_PROP_TEXTURE_SDR_WHITE_POINT_FLOAT: for HDR10 and floating point textures, this defines the value of 100% diffuse white, with higher values being displayed in the High Dynamic Range headroom. This defaults to 100 for HDR10 textures and 1.0 for other textures.
• sDL_PROP_TEXTURE_HDR_HEADROOM_FLOAT: for HDR10 and floating point textures, this defines the maximum dynamic range used by the content, in terms of the SDR white point. If this is defined, any values outside the range supported by the display will be scaled into the available HDR headroom, otherwise they are clipped. This defaults to 1.0 for SDR textures, 4.0 for HDR10 textures, and no default for floating point textures.

With the direct3d11 renderer:

• sDL_PROP_TEXTURE_D3D11_TEXTURE_POINTER: the ID3D11Texture2D associated with the texture
• sDL_PROP_TEXTURE_D3D11_TEXTURE_U_POINTER: the ID3D11Texture2D associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_D3D11_TEXTURE_V_POINTER: the ID3D11Texture2D associated with the V plane of a YUV texture

With the direct3d12 renderer:

• sDL_PROP_TEXTURE_D3D12_TEXTURE_POINTER: the ID3D12Resource associated with the texture
• sDL_PROP_TEXTURE_D3D12_TEXTURE_U_POINTER: the ID3D12Resource associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_D3D12_TEXTURE_V_POINTER: the ID3D12Resource associated with the V plane of a YUV texture

With the vulkan renderer:

• sDL_PROP_TEXTURE_VULKAN_TEXTURE_NUMBER: the VkImage associated with the texture

With the opengl renderer:

• sDL_PROP_TEXTURE_OPENGL_TEXTURE_NUMBER: the GLuint texture associated with the texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGL_TEXTURE_TARGET_NUMBER: the GLenum for the texture target (GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE_ARB, etc)
• sDL_PROP_TEXTURE_OPENGL_TEX_W_FLOAT: the texture coordinate width of the texture (0.0 - 1.0)
• sDL_PROP_TEXTURE_OPENGL_TEX_H_FLOAT: the texture coordinate height of the texture (0.0 - 1.0)

With the opengles2 renderer:

• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_NUMBER: the GLuint texture associated with the texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_UV_NUMBER: the GLuint texture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_U_NUMBER: the GLuint texture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_V_NUMBER: the GLuint texture associated with the V plane of a YUV texture
• sDL_PROP_TEXTURE_OPENGLES2_TEXTURE_TARGET_NUMBER: the GLenum for the texture target (GL_TEXTURE_2D, GL_TEXTURE_EXTERNAL_OES, etc)

With the gpu renderer:

• sDL_PROP_TEXTURE_GPU_TEXTURE_POINTER: the SDL_GPUTexture associated with the texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_UV_POINTER: the SDL_GPUTexture associated with the UV plane of an NV12 texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_U_POINTER: the SDL_GPUTexture associated with the U plane of a YUV texture
• sDL_PROP_TEXTURE_GPU_TEXTURE_V_POINTER: the SDL_GPUTexture associated with the V plane of a YUV texture

Returns

a valid property ID on success or 0 on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the renderer that created an SDL_Texture.

Returns

a pointer to the SDL_Renderer that created the texture, or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the renderer that created an SDL_Texture.

Returns

a pointer to the SDL_Renderer that created the texture, or NULL on failure; call getError for more information.

Thread safety

It is safe to call this function from any thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the size of a texture, as floating point values.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Get the size of a texture, as floating point values.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

sdl3-bindgen-sys notes

Since: 3.2.0

Set the palette used by a texture.

Setting the palette keeps an internal reference to the palette, which can be safely destroyed afterwards.

A single palette can be shared with many textures.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createPalette, getTexturePalette

sdl3-bindgen-sys notes

Since: 3.4.0

Set the palette used by a texture.

Setting the palette keeps an internal reference to the palette, which can be safely destroyed afterwards.

A single palette can be shared with many textures.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

createPalette, getTexturePalette

sdl3-bindgen-sys notes

Since: 3.4.0

Get the palette used by a texture.

Returns

a pointer to the palette used by the texture, or NULL if there is no palette used.

Thread safety

This function should only be called on the main thread.

See also

setTexturePalette

sdl3-bindgen-sys notes

Since: 3.4.0

Get the palette used by a texture.

Returns

a pointer to the palette used by the texture, or NULL if there is no palette used.

Thread safety

This function should only be called on the main thread.

See also

setTexturePalette

sdl3-bindgen-sys notes

Since: 3.4.0

Set an additional color value multiplied into render copy operations.

When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Color modulation is not always supported by the renderer; it will return false if color modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureColorMod, setTextureAlphaMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional color value multiplied into render copy operations.

When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * (color / 255)

Color modulation is not always supported by the renderer; it will return false if color modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureColorMod, setTextureAlphaMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional color value multiplied into render copy operations.

When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * color

Color modulation is not always supported by the renderer; it will return false if color modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureColorModFloat, setTextureAlphaModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional color value multiplied into render copy operations.

When this texture is rendered, during the copy operation each source color channel is modulated by the appropriate color value according to the following formula:

srcC = srcC * color

Color modulation is not always supported by the renderer; it will return false if color modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureColorModFloat, setTextureAlphaModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional color value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, getTextureColorModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional color value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, getTextureColorModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional color value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, getTextureColorMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional color value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, getTextureColorMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional alpha value multiplied into render copy operations.

When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * (alpha / 255)

Alpha modulation is not always supported by the renderer; it will return false if alpha modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, setTextureAlphaModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional alpha value multiplied into render copy operations.

When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * (alpha / 255)

Alpha modulation is not always supported by the renderer; it will return false if alpha modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, setTextureAlphaModFloat, setTextureColorMod

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional alpha value multiplied into render copy operations.

When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * alpha

Alpha modulation is not always supported by the renderer; it will return false if alpha modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, setTextureAlphaMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Set an additional alpha value multiplied into render copy operations.

When this texture is rendered, during the copy operation the source alpha value is modulated by this alpha value according to the following formula:

srcA = srcA * alpha

Alpha modulation is not always supported by the renderer; it will return false if alpha modulation is not supported.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, setTextureAlphaMod, setTextureColorModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional alpha value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, getTextureColorMod, setTextureAlphaMod

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional alpha value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaModFloat, getTextureColorMod, setTextureAlphaMod

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional alpha value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, getTextureColorModFloat, setTextureAlphaModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Get the additional alpha value multiplied into render copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureAlphaMod, getTextureColorModFloat, setTextureAlphaModFloat

sdl3-bindgen-sys notes

Since: 3.2.0

Set the blend mode for a texture, used by renderTexture.

This blend mode is used for any drawing that involves this texture.

If the blend mode is not supported, the closest supported mode is chosen and this function returns false.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureBlendMode, setRenderDrawBlendMode

sdl3-bindgen-sys notes

Since: 3.2.0

Set the blend mode for a texture, used by renderTexture.

This blend mode is used for any drawing that involves this texture.

If the blend mode is not supported, the closest supported mode is chosen and this function returns false.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureBlendMode, setRenderDrawBlendMode

sdl3-bindgen-sys notes

Since: 3.2.0

Get the blend mode used for texture copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

setTextureBlendMode

sdl3-bindgen-sys notes

Since: 3.2.0

Get the blend mode used for texture copy operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

setTextureBlendMode

sdl3-bindgen-sys notes

Since: 3.2.0

Set the scale mode used for texture scale operations.

The default texture scale mode is SDL_SCALEMODE_LINEAR.

If the scale mode is not supported, the closest supported mode is chosen.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureScaleMode

sdl3-bindgen-sys notes

Since: 3.2.0

Set the scale mode used for texture scale operations.

The default texture scale mode is SDL_SCALEMODE_LINEAR.

If the scale mode is not supported, the closest supported mode is chosen.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

getTextureScaleMode

sdl3-bindgen-sys notes

Since: 3.2.0

Get the scale mode used for texture scale operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

setTextureScaleMode

sdl3-bindgen-sys notes

Since: 3.2.0

Get the scale mode used for texture scale operations.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

setTextureScaleMode

sdl3-bindgen-sys notes

Since: 3.2.0

Update the given texture rectangle with new pixel data.

The pixel data must be in the pixel format of the texture, which can be queried using the SDL_PROP_TEXTURE_FORMAT_NUMBER property.

This is a fairly slow function, intended for use with static textures that do not change often.

If the texture is intended to be updated often, it is preferred to create the texture as streaming and use the locking functions referenced below. While this function will work with streaming textures, for optimization reasons you may not get the pixels back if you lock the texture afterward.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

lockTexture, unlockTexture, updateNVTexture, updateYUVTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Update the given texture rectangle with new pixel data.

The pixel data must be in the pixel format of the texture, which can be queried using the SDL_PROP_TEXTURE_FORMAT_NUMBER property.

This is a fairly slow function, intended for use with static textures that do not change often.

If the texture is intended to be updated often, it is preferred to create the texture as streaming and use the locking functions referenced below. While this function will work with streaming textures, for optimization reasons you may not get the pixels back if you lock the texture afterward.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

lockTexture, unlockTexture, updateNVTexture, updateYUVTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Update a rectangle within a planar YV12 or IYUV texture with new pixel data.

You can use updateTexture as long as your pixel data is a contiguous block of Y and U/V planes in the proper order, but this function is available if your pixel data is not contiguous.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

updateNVTexture, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Update a rectangle within a planar YV12 or IYUV texture with new pixel data.

You can use updateTexture as long as your pixel data is a contiguous block of Y and U/V planes in the proper order, but this function is available if your pixel data is not contiguous.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

updateNVTexture, updateTexture

sdl3-bindgen-sys notes

Since: 3.2.0

Update a rectangle within a planar NV12 or NV21 texture with new pixels.

You can use updateTexture as long as your pixel data is a contiguous block of NV12/21 planes in the proper order, but this function is available if your pixel data is not contiguous.

Returns

true on success or false on failure; call getError for more information.

Thread safety

This function should only be called on the main thread.

See also

updateTexture, updateYUVTexture

sdl3-bindgen-sys notes

Since: 3.2.0