Wiki Page Content

Differences between revisions 5 and 6
Revision 5 as of 2011-09-16 17:50:15
Size: 998
Editor: SheenaSmith
Comment: update content - 9/16 2abc5a4210d5 (add NULL handling in Remarks); camelcase
Revision 6 as of 2013-08-11 12:25:26
Size: 998
Comment: Changed parameter names to match SDL_rect.h.
Deletions are marked like this. Additions are marked like this.
Line 11: Line 11:
SDL_bool SDL_RectEquals(const SDL_Rect* A,
                        const SDL_Rect* B)
SDL_bool SDL_RectEquals(const SDL_Rect* a,
                        const SDL_Rect* b)
Line 16: Line 16:
||'''A'''||an [[SDL_Rect]] structure representing the first rectangle||
||'''B'''||an [[SDL_Rect]] structure representing the second rectangle||
||'''a'''||an [[SDL_Rect]] structure representing the first rectangle||
||'''b'''||an [[SDL_Rect]] structure representing the second rectangle||

SDL_RectEquals

Use this function to check whether two rectangles are equal.

Syntax

SDL_bool SDL_RectEquals(const SDL_Rect* a,
                        const SDL_Rect* b)

Function Parameters

a

an SDL_Rect structure representing the first rectangle

b

an SDL_Rect structure representing the second rectangle

Return Value

Returns SDL_TRUE if the two rectangles are exactly the same, SDL_FALSE otherwise; see Remarks for details.

Code Examples

You can add your code example here

Remarks

This function compares the width, height, and location (X and Y) values for each of the two rectangles and returns SDL_TRUE if all corresponding values are equal. If any value does not match or either rectangle is NULL it returns SDL_FALSE.


CategoryAPI, CategoryRect

None: SDL_RectEquals (last edited 2013-08-11 12:25:26 by PhilippWiesemann)

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