FSlateClippingState | Unreal Engine 5.7 Documentation

Captures everything about a single draw calls clipping state.


Name	FSlateClippingState
Type	class
Header File	/Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h
Include Path	#include "Layout/Clipping.h"

Syntax

class FSlateClippingState

Name	Remarks	Include Path	Unreal Specifiers
FSlateClippingState ( EClippingFlags InFlags )		Layout/Clipping.h

Name	Type	Remarks	Include Path	Unreal Specifiers
ScissorRect	TOptional< FSlateClippingZone >	If this is an axis aligned clipping state, this will be filled.	Layout/Clipping.h
StencilQuads	TArray< FSlateClippingZone >	If this is a more expensive stencil clipping zone, this will be filled.	Layout/Clipping.h

Name	Type	Remarks	Include Path
Debugging_StateIndex	int32	For a given frame, this is a unique index into a state array of clipping zones that have been registered for a window being drawn.	Layout/Clipping.h
Debugging_StateIndexFromFrame	int32		Layout/Clipping.h
Flags	EClippingFlags	The specialized flags needed for this clipping state.	Layout/Clipping.h

Name	Remarks	Include Path
bool GetAlwaysClip()		Layout/Clipping.h
EClippingMethod GetClippingMethod ()	Gets the type of clipping that is required by this clipping state.	Layout/Clipping.h
bool GetShouldIntersectParent()		Layout/Clipping.h
bool HasZeroArea ()	Indicates if this clipping state has a zero size, aka is empty.	Layout/Clipping.h
bool IsPointInside ( const UE::Slate::FDeprecateVector2DParameter& Point ) const	Is a point inside the clipping state?	Layout/Clipping.h
void SetDebuggingStateIndex ( int32 InStateIndex ) const	Set the state index that this clipping state originated from.	Layout/Clipping.h

Name	Remarks	Include Path	Unreal Specifiers
bool operator== ( const FSlateClippingState& Other ) const		Layout/Clipping.h