rose::gm::ClipRectangleGuard Class Reference

Store the current clip rectangle replacing it with a new clip rectangle. More...

#include <GraphicsModel.h>

Collaboration diagram for rose::gm::ClipRectangleGuard:

Public Member Functions
	ClipRectangleGuard ()=delete
	Deleted default constructor.
	ClipRectangleGuard (const ClipRectangleGuard &)=delete
	Deleted copy constructor.
	operator bool () const
	~ClipRectangleGuard ()
	Set the old clip rectangle back on the renderer when destroyed.
	ClipRectangleGuard (Context &context)
	Speculative constructor. More...
	ClipRectangleGuard (Context &context, const SDL_Rect &clip)
	Constructor. More...
	ClipRectangleGuard (Context &context, int x, int y, int w, int h)
	Constructor. More...
	ClipRectangleGuard (Context &context, const Rectangle &clip)
	Conditional constructor. More...
ClipRectangleGuard &	operator= (SDL_Rect &clip)
	Assign a new clip rectangle through the ClipRectangleGuard. More...
ClipRectangleGuard &	operator= (Rectangle &clip)
	Assign a new clip rectangle through the ClipRectangleGuard. More...
ClipRectangleGuard &	intersection (Rectangle &clip)

Protected Attributes
Context &	mContext
	The renderer to which the clip rectangles are set.
SDL_Rect	mOldClip {}
	The old clip rectangle.
int	mStatus {0}

Detailed Description

Store the current clip rectangle replacing it with a new clip rectangle.

When the object is destroyed (by going out of scope) the old clip rectangle is set.

Constructor & Destructor Documentation

ClipRectangleGuard() [1/4]

rose::gm::ClipRectangleGuard::ClipRectangleGuard ( Context &  context )

inlineexplicit

Speculative constructor.

This constructor saves the current clip rectangle to be restored later, but does not set a new clip rectangle. A new clip rectangle may be set using the assignment operators.

Parameters

context

The renderer to guard the clip rectangle of.

ClipRectangleGuard() [2/4]

rose::gm::ClipRectangleGuard::ClipRectangleGuard ( Context &  context, const SDL_Rect &  clip  )

inline

Constructor.

Store the current clip rectangle and set the new one.

Parameters

context	The renderer to set the clip rectangles on.
clip	The new clip rectangle.

ClipRectangleGuard() [3/4]

rose::gm::ClipRectangleGuard::ClipRectangleGuard ( Context &  context, int  x, int  y, int  w, int  h  )

inline

Constructor.

Store the current clip rectangle and set the new one.

Parameters

renderer	The renderer to set the clip rectangles on.
x	X co-ordinate of the new clip rectangle.
y	Y co-ordinate of the new clip rectangle.
w	Width of the new clip rectangle.
h	Height of the new clip rectangle.

ClipRectangleGuard() [4/4]

rose::gm::ClipRectangleGuard::ClipRectangleGuard ( Context &  context, const Rectangle &  clip  )

inline

Conditional constructor.

This constructor saves the current clip rectangle to be restored later. If clip is valid it is converted to an SDL_Rect and set as the new clip rectangle

Parameters

renderer	The renderer to set the clip rectangles on.
clip	A, possibly invalid, RectangleInt.

Member Function Documentation

operator=() [1/2]

ClipRectangleGuard& rose::gm::ClipRectangleGuard::operator= ( SDL_Rect &  clip )

inline

Assign a new clip rectangle through the ClipRectangleGuard.

Parameters

clip	The new clip rectangle.

Returns

The ClipRectangleGuard.

operator=() [2/2]

ClipRectangleGuard& rose::gm::ClipRectangleGuard::operator= ( Rectangle &  clip )

inline

Assign a new clip rectangle through the ClipRectangleGuard.

If clip is invalid no changes are made.

Parameters

clip	The new clip rectangle.

Returns

The ClipRectangleGuard.

---

The documentation for this class was generated from the following file:

• src/GraphicsModel.h