Wiki Page Content

Differences between revisions 8 and 9
Revision 8 as of 2011-01-06 18:40:10
Size: 1412
Editor: SheenaSmith
Comment: update content - w/ Sam; remove draft
Revision 9 as of 2011-01-06 18:41:59
Size: 1412
Editor: SheenaSmith
Comment: minor change
Deletions are marked like this. Additions are marked like this.
Line 32: Line 32:
If there is a clip rectangle set on the destination (set via [[SDL_SetClipRect]]()), then this function will clip based on the intersection of the clip rectangle and '''rect'''. If there is a clip rectangle set on the destination (set via [[SDL_SetClipRect]]()), then this function will fill based on the intersection of the clip rectangle and '''rect'''.

SDL_FillRect

Use this function to perform a fast fill of a rectangle with a specific color.

Syntax

int SDL_FillRect(SDL_Surface*    dst,
                 const SDL_Rect* rect,
                 Uint32          color)

Function Parameters

dst

the SDL_Surface structure that is the drawing target

rect

the SDL_Rect structure representing the rectangle to fill, or NULL to fill the entire surface

color

the color to fill with; see Remarks for details

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

color should be a pixel of the format used by the surface, and can be generated by SDL_MapRGB() or SDL_MapRGBA(). If the color value contains an alpha component then the destination is simply filled with that alpha information, no blending takes place.

If there is a clip rectangle set on the destination (set via SDL_SetClipRect()), then this function will fill based on the intersection of the clip rectangle and rect.


CategoryAPI, CategorySurface

None: SDL_FillRect (last edited 2014-07-04 11:27:03 by PhilippWiesemann)

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