Wiki Page Content

Differences between revisions 27 and 28
Revision 27 as of 2015-08-21 21:06:43
Size: 1863
Comment: Corrected return value.
Revision 28 as of 2017-08-11 23:59:53
Size: 2032
Editor: ChliHug
Comment: Added information about the possible difference of the pixel format.
Deletions are marked like this. Additions are marked like this.
Line 62: Line 62:
Line 63: Line 64:

The pixel format of the created texture may be different from the pixel format of the surface. Use [[SDL_QueryTexture]]() to query the pixel format of the texture.

SDL_CreateTextureFromSurface

Use this function to create a texture from an existing surface.

Syntax

SDL_Texture* SDL_CreateTextureFromSurface(SDL_Renderer* renderer,
                                          SDL_Surface*  surface)

Function Parameters

renderer

the rendering context

surface

the SDL_Surface structure containing pixel data used to fill the texture

Return Value

Returns the created texture or NULL on failure; call SDL_GetError() for more information.

Code Examples

Uint32 rmask, gmask, bmask, amask;

/* SDL interprets each pixel as a 32-bit number, so our masks must depend
   on the endianness (byte order) of the machine */
#if SDL_BYTEORDER == SDL_BIG_ENDIAN
    rmask = 0xff000000;
    gmask = 0x00ff0000;
    bmask = 0x0000ff00;
    amask = 0x000000ff;
#else
    rmask = 0x000000ff;
    gmask = 0x0000ff00;
    bmask = 0x00ff0000;
    amask = 0xff000000;
#endif

SDL_Surface *surface = SDL_CreateRGBSurface(0, 640, 480, 32, rmask, gmask, bmask, amask);

if (surface == NULL) {
    fprintf(stderr, "CreateRGBSurface failed: %s\n", SDL_GetError());
    exit(1);
}


SDL_Texture *texture = SDL_CreateTextureFromSurface(renderer, surface);

if (texture == NULL) {
    fprintf(stderr, "CreateTextureFromSurface failed: %s\n", SDL_GetError());
    exit(1);
}

SDL_FreeSurface(surface);
surface = NULL;

Remarks

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. Use SDL_QueryTexture() to query the pixel format of the texture.


CategoryAPI, CategoryRender

None: SDL_CreateTextureFromSurface (last edited 2017-08-11 23:59:53 by ChliHug)

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