SDL_QueryTexture

Use this function to query the attributes of a texture.

Syntax

int SDL_QueryTexture(SDL_Texture* texture,
                     Uint32*      format, 
                     int*         access,
                     int*         w, 
                     int*         h)

Function Parameters

texture

the texture to query

format

a pointer filled in with the raw format of the texture; the actual format may differ, but pixel transfers will use this format; see Remarks for details

access

a pointer filled in with the actual access to the texture

w

a pointer filled in with the width of the texture in pixels

h

a pointer filled in with the height of the texture in pixels

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

format may be one of the following:

SDL_PIXELFORMAT_UNKNOWN

SDL_PIXELFORMAT_INDEX1LSB

SDL_PIXELFORMAT_INDEX1MSB

SDL_PIXELFORMAT_INDEX4LSB

SDL_PIXELFORMAT_INDEX4MSB

SDL_PIXELFORMAT_INDEX8

SDL_PIXELFORMAT_RGB332

SDL_PIXELFORMAT_RGB444

SDL_PIXELFORMAT_RGB555

SDL_PIXELFORMAT_BGR555

SDL_PIXELFORMAT_ARGB4444

SDL_PIXELFORMAT_ABGR4444

SDL_PIXELFORMAT_ARGB1555

SDL_PIXELFORMAT_ABGR1555

SDL_PIXELFORMAT_RGB565

SDL_PIXELFORMAT_BGR565

SDL_PIXELFORMAT_RGB24

SDL_PIXELFORMAT_BGR24

SDL_PIXELFORMAT_RGB888

SDL_PIXELFORMAT_BGR888

SDL_PIXELFORMAT_ARGB8888

SDL_PIXELFORMAT_RGBA8888

SDL_PIXELFORMAT_ABGR8888

SDL_PIXELFORMAT_BGRA8888

SDL_PIXELFORMAT_ARGB2101010

SDL_PIXELFORMAT_YV12

planar mode: Y + V + U (3 planes)

SDL_PIXELFORMAT_IYUV

planar mode: Y + U + V (3 planes)

SDL_PIXELFORMAT_YUY2

packed mode: Y0+U0+Y1+V0 (1 plane)

SDL_PIXELFORMAT_UYVY

packed mode: U0+Y0+V0+Y1 (1 plane)

SDL_PIXELFORMAT_YVYU

packed mode: Y0+V0+Y1+U0 (1 plane)


CategoryAPI, CategoryVideo

SDL_QueryTexture (last edited 2011-01-04 19:19:36 by SheenaSmith)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit