SDL_SetRenderTarget

Set a texture as the current rendering target.

Syntax

int SDL_SetRenderTarget(SDL_Renderer *renderer,
                        SDL_Texture *texture);

Function Parameters

renderer	the rendering context
texture	the targeted texture, which must be created with the SDL_TEXTUREACCESS_TARGET flag, or NULL to render to the window instead of a texture.

Return Value

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

Remarks

Before using this function, you should check the SDL_RENDERER_TARGETTEXTURE bit in the flags of SDL_RendererInfo to see if render targets are supported.

The default render target is the window for which the renderer was created. To stop rendering to a texture and render to the window again, call this function with a NULL texture.

Version

This function is available since SDL 2.0.0.

Related Functions

SDL_GetRenderTarget

---

CategoryAPI, CategoryRender

---

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.