Wiki Page Content

Differences between revisions 1 and 7 (spanning 6 versions)
Revision 1 as of 2013-06-15 17:40:41
Size: 831
Comment: add SDL_RenderGetClipRect
Revision 7 as of 2015-06-20 19:51:37
Size: 1057
Comment: Added more parameter description from header file and corrected syntax, see SGFunctions.
Deletions are marked like this. Additions are marked like this.
Line 8: Line 8:
= SDL_RenderGetClipRect =
Use this function to get the clip rectangle for the current target.
= SDL_RenderSetClipRect =
Use this function to set the clip rectangle for rendering on the specified target.
Line 16: Line 16:
void SDL_RenderGetClipRect(SDL_Renderer* renderer,
                           SDL_Rect*     rect);
int SDL_RenderSetClipRect(SDL_Renderer*   renderer,
                          const SDL_Rect* rect)
Line 22: Line 22:
||'''renderer'''||the rendering context||
||'''rect'''||an [[SDL_Rect]] structure filled in with the current clipping area||
||'''renderer'''||the rendering context for which clip rectangle should be set||
||'''rect'''||an [[SDL_Rect]] structure representing the clip area, or NULL to disable clipping||
Line 25: Line 25:
== Return Value ==
Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information.
Line 37: Line 39:
 .[[SDL_RenderSetClipRect]]  .[[SDL_RenderGetClipRect]]
 .[[SDL_RenderIsClipEnabled]]

SDL_RenderSetClipRect

Use this function to set the clip rectangle for rendering on the specified target.

Syntax

int SDL_RenderSetClipRect(SDL_Renderer*   renderer,
                          const SDL_Rect* rect)

Function Parameters

renderer

the rendering context for which clip rectangle should be set

rect

an SDL_Rect structure representing the clip area, or NULL to disable clipping

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

You can add useful comments here


CategoryAPI, CategoryRender

None: SDL_RenderSetClipRect (last edited 2015-06-20 19:51:37 by PhilippWiesemann)

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