LiteFX::Rendering::Scissor Class Reference

Implements a scissor. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IScissor.

Classes
class	ScissorImpl

Public Member Functions
	Scissor (const RectF &scissorRect={ }) noexcept
	Initializes a new scissor.
	Scissor (const Scissor &_other)
	Creates a copy of a scissor.
	Scissor (Scissor &&_other) noexcept
	Takes over another instance of a scissor.
Scissor &	operator= (const Scissor &_other)
	Assigns a scissor by copying it.
Scissor &	operator= (Scissor &&_other) noexcept
	Assigns a scissor by taking it over.
	~Scissor () noexcept override
	Releases the scissor instance.
RectF	getRectangle () const noexcept override
	Gets the rectangle that defines the scissor region. Returns The rectangle that defines the scissor region.
void	setRectangle (const RectF &rectangle) noexcept override
	Sets the rectangle that defines the scissor region. Parameters rectangle The rectangle that defines the scissor region.</rectangle>
Public Member Functions inherited from LiteFX::Rendering::IScissor
virtual	~IScissor () noexcept=default

Additional Inherited Members
Protected Member Functions inherited from LiteFX::Rendering::IScissor
	IScissor () noexcept=default
	IScissor (IScissor &&) noexcept=default
	IScissor (const IScissor &)=default
IScissor &	operator= (IScissor &&) noexcept=default
IScissor &	operator= (const IScissor &)=default

Detailed Description

Implements a scissor.

Constructor & Destructor Documentation

Scissor() [1/3]

Scissor::Scissor ( const RectF & scissorRect = { } )

explicitnoexcept

Initializes a new scissor.

Parameters

scissorRect

The rectangle that defines the scissor region.

Scissor() [2/3]

LiteFX::Rendering::Scissor::Scissor

(

const Scissor &

_other

)

Creates a copy of a scissor.

Parameters

_other

The scissor instance to copy.

Scissor() [3/3]

LiteFX::Rendering::Scissor::Scissor ( Scissor && _other )

noexcept

Takes over another instance of a scissor.

Parameters

_other

The scissor instance to take over.

~Scissor()

Scissor::~Scissor ( )

overridedefaultnoexcept

Releases the scissor instance.

Member Function Documentation

getRectangle()

RectF Scissor::getRectangle ( ) const

overridevirtualnoexcept

Gets the rectangle that defines the scissor region.

Returns

The rectangle that defines the scissor region.

Implements LiteFX::Rendering::IScissor.

operator=() [1/2]

Scissor & LiteFX::Rendering::Scissor::operator=

(

const Scissor &

_other

)

Assigns a scissor by copying it.

Parameters

_other

The scissor instance to copy.

Returns

A reference to the current scissor instance.

operator=() [2/2]

Scissor & LiteFX::Rendering::Scissor::operator= ( Scissor && _other )

noexcept

Assigns a scissor by taking it over.

Parameters

_other

The scissor to take over.

Returns

A reference to the current scissor instance.

setRectangle()

void Scissor::setRectangle ( const RectF & rectangle )

overridevirtualnoexcept

Sets the rectangle that defines the scissor region.

Parameters

rectangle

The rectangle that defines the scissor region.</rectangle>

Implements LiteFX::Rendering::IScissor.