utility::graphic::ScissorRect Struct Reference

Axis-aligned scissor (clip) rectangle. More...

#include <headers/utility/graphic/scissor.hpp>

Public Member Functions
bool	operator== (const ScissorRect &other) const
	Equality operator.
bool	operator!= (const ScissorRect &other) const
	Inequality operator.

Public Attributes
float	x { 0.0f }
	Rectangle origin along X, in pixels.
float	y { 0.0f }
	Rectangle origin along Y, in pixels.
float	width { 0.0f }
	Rectangle width, in pixels.
float	height { 0.0f }
	Rectangle height, in pixels.

Detailed Description

Axis-aligned scissor (clip) rectangle.

Coordinates are expressed in framebuffer pixels, with the origin at the top-left corner of the render target. Engines are expected to clamp the rectangle to their render target extent.

Definition at line 35 of file scissor.hpp.

Member Function Documentation

operator!=()

bool utility::graphic::ScissorRect::operator!= ( const ScissorRect &  other ) const

inline

Inequality operator.

Parameters

other

The other rectangle to compare with.

Returns

True when the rectangles differ.

Definition at line 57 of file scissor.hpp.

operator==()

bool utility::graphic::ScissorRect::operator== ( const ScissorRect &  other ) const

inline

Equality operator.

Parameters

other

The other rectangle to compare with.

Returns

True when both rectangles have identical components.

Definition at line 46 of file scissor.hpp.

Member Data Documentation

height

float utility::graphic::ScissorRect::height { 0.0f }

Rectangle height, in pixels.

Definition at line 39 of file scissor.hpp.

width

float utility::graphic::ScissorRect::width { 0.0f }

Rectangle width, in pixels.

Definition at line 38 of file scissor.hpp.

x

float utility::graphic::ScissorRect::x { 0.0f }

Rectangle origin along X, in pixels.

Definition at line 36 of file scissor.hpp.

y

float utility::graphic::ScissorRect::y { 0.0f }

Rectangle origin along Y, in pixels.

Definition at line 37 of file scissor.hpp.

---

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

• headers/utility/graphic/scissor.hpp