FSlateClippingState Class Reference

#include <Clipping.h>

Public Member Functions
SLATECORE_API	FSlateClippingState (EClippingFlags InFlags=EClippingFlags::None)
SLATECORE_API bool	IsPointInside (const UE::Slate::FDeprecateVector2DParameter &Point) const
bool	GetAlwaysClip () const
bool	GetShouldIntersectParent () const
EClippingMethod	GetClippingMethod () const
bool	HasZeroArea () const
bool	operator== (const FSlateClippingState &Other) const

Public Attributes
TArray< FSlateClippingZone >	StencilQuads
TOptional< FSlateClippingZone >	ScissorRect

Detailed Description

Captures everything about a single draw calls clipping state.

Constructor & Destructor Documentation

FSlateClippingState()

FSlateClippingState::FSlateClippingState

(

EClippingFlags

InFlags = EClippingFlags::None

)

Member Function Documentation

GetAlwaysClip()

bool FSlateClippingState::GetAlwaysClip ( ) const

inline

GetClippingMethod()

EClippingMethod FSlateClippingState::GetClippingMethod ( ) const

inline

Gets the type of clipping that is required by this clipping state. The simpler clipping is scissor clipping, but that's only possible if the clipping rect is axis aligned.

GetShouldIntersectParent()

bool FSlateClippingState::GetShouldIntersectParent ( ) const

inline

HasZeroArea()

bool FSlateClippingState::HasZeroArea ( ) const

inline

Indicates if this clipping state has a zero size, aka is empty. We only possibly report true for scissor clipping zones.

IsPointInside()

bool FSlateClippingState::IsPointInside

(

const UE::Slate::FDeprecateVector2DParameter &

Point

)

const

Is a point inside the clipping state?

operator==()

bool FSlateClippingState::operator== ( const FSlateClippingState &  Other ) const

inline

Member Data Documentation

ScissorRect

TOptional<FSlateClippingZone> FSlateClippingState::ScissorRect

If this is an axis aligned clipping state, this will be filled.

StencilQuads

TArray<FSlateClippingZone> FSlateClippingState::StencilQuads

If this is a more expensive stencil clipping zone, this will be filled.

---

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

• Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h
• Engine/Source/Runtime/SlateCore/Private/Layout/Clipping.cpp