devela::_dep::sdl3::sys::render

Function SDL_UpdateTexture

pub unsafe extern "C" fn SDL_UpdateTexture(
    texture: *mut SDL_Texture,
    rect: *const SDL_Rect,
    pixels: *const c_void,
    pitch: i32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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.

§Parameters

  • texture: the texture to update.
  • rect: an SDL_Rect structure representing the area to update, or NULL to update the entire texture.
  • pixels: the raw pixel data in the format of the texture.
  • pitch: the number of bytes in a row of pixel data, including padding between lines.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Thread safety

This function should only be called on the main thread.

§Availability

This function is available since SDL 3.2.0.

§See also