IMG_LoadGPUTextureTyped_IO - Man Page

#include <SDL3_image/SDL_image.h>

SDL_GPUTexture * IMG_LoadGPUTextureTyped_IO(SDL_GPUDevice *device, SDL_GPUCopyPass *copy_pass, SDL_IOStream *src, bool closeio, const char *type, int *width, int *height);

An SDL_GPUTexture represents an image in GPU memory, usable by SDL's GPU API. Regardless of the source format of the image, this function will create a GPU texture with the format SDL_GPU_TEXTUREFORMAT_R8G8B8A8_UNORM with no mip levels. It can be bound as a sampled texture from a graphics or compute pipeline and as a a readonly storage texture in a compute pipeline.

If closeio is true, src will be closed before returning, whether this function succeeds or not. SDL_image reads everything it needs from src during this call in any case.

Even though this function accepts a file type, SDL_image may still try other decoders that are capable of detecting file type from the contents of the image data, but may rely on the caller-provided type string for formats that it cannot autodetect. If type is NULL, SDL_image will rely solely on its ability to guess the format.

There is a separate function to read files from disk without having to deal with SDL_IOStream: `IMG_LoadGPUTexture(device, copy_pass, "filename.jpg", width, height) will call this function and manage those details for you, determining the file type from the filename's extension.

There is also IMG_LoadGPUTexture_IO(), which is equivalent to this function except that it will rely on SDL_image to determine what type of data it is loading, much like passing a NULL for type.

When done with the returned texture, the app should dispose of it with a call to SDL_ReleaseGPUTexture().

device

the SDL_GPUDevice to use to create the GPU texture.

copy_pass

the SDL_GPUCopyPass to use to upload the loaded image to the GPU texture.

src

an SDL_IOStream that data will be read from.

closeio

true to close/free the SDL_IOStream before returning, false to leave it open.

type

a filename extension that represent this data ("BMP", "GIF", "PNG", etc).

width

a pointer filled in with the width of the GPU texture. may be NULL.

height

a pointer filled in with the width of the GPU texture. may be NULL.

Returns a new GPU texture, or NULL on error.

This function is available since SDL_image 3.4.0.

IMG_LoadGPUTexture(3), IMG_LoadGPUTexture_IO(3)

IMG_LoadGPUTexture(3), IMG_LoadGPUTexture_IO(3).