UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FSlateClippingManager Class Reference

#include <Clipping.h>

Public Member Functions

SLATECORE_API FSlateClippingManager ()
 
SLATECORE_API int32 PushClip (const FSlateClippingZone &InClippingZone)
 
SLATECORE_API int32 PushClippingState (const FSlateClippingState &InClipState)
 
SLATECORE_API int32 GetClippingIndex () const
 
SLATECORE_API TOptional< FSlateClippingStateGetActiveClippingState () const
 
const TArray< int32 > & GetClippingStack () const
 
SLATECORE_API const TArray< FSlateClippingState > & GetClippingStates () const
 
SLATECORE_API void PopClip ()
 
SLATECORE_API void PopToStackIndex (int32 Index)
 
int32 GetClippingIndexAtStackIndex (int32 StackIndex) const
 
int32 GetStackDepth () const
 
SLATECORE_API const FSlateClippingStateGetPreviousClippingState (bool bWillIntersectWithParent) const
 
SLATECORE_API void ResetClippingState ()
 

Detailed Description

The clipping manager maintain the running clip state. This is used for both maintain and for hit testing.

Constructor & Destructor Documentation

◆ FSlateClippingManager()

FSlateClippingManager::FSlateClippingManager ( )

Member Function Documentation

◆ GetActiveClippingState()

TOptional< FSlateClippingState > FSlateClippingManager::GetActiveClippingState ( ) const

◆ GetClippingIndex()

int32 FSlateClippingManager::GetClippingIndex ( ) const

◆ GetClippingIndexAtStackIndex()

int32 FSlateClippingManager::GetClippingIndexAtStackIndex ( int32  StackIndex) const
inline

◆ GetClippingStack()

const TArray< int32 > & FSlateClippingManager::GetClippingStack ( ) const
inline

◆ GetClippingStates()

const TArray< FSlateClippingState > & FSlateClippingManager::GetClippingStates ( ) const

◆ GetPreviousClippingState()

const FSlateClippingState * FSlateClippingManager::GetPreviousClippingState ( bool  bWillIntersectWithParent) const

◆ GetStackDepth()

int32 FSlateClippingManager::GetStackDepth ( ) const
inline

◆ PopClip()

void FSlateClippingManager::PopClip ( )

◆ PopToStackIndex()

void FSlateClippingManager::PopToStackIndex ( int32  Index)

◆ PushClip()

int32 FSlateClippingManager::PushClip ( const FSlateClippingZone InClippingZone)

◆ PushClippingState()

int32 FSlateClippingManager::PushClippingState ( const FSlateClippingState InClipState)

◆ ResetClippingState()

void FSlateClippingManager::ResetClippingState ( )

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