Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FSlateClippingState

Captures everything about a single draw calls clipping state.

Windows

MacOS

Linux

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Layout/Clipping.h
Include	#include "Layout/Clipping.h"

Syntax

class FSlateClippingState

Remarks

Captures everything about a single draw calls clipping state.

Variables

		Name	Description
	TOptional< FSla...	ScissorRect	If this is an axis aligned clipping state, this will be filled.
	TArray< FSlateC...	StencilQuads	If this is a more expensive stencil clipping zone, this will be filled.

Constructors

	Name	Description
	FSlateClippingState ( EClippingFlags InFlags )
	FSlateClippingState ( const FSlateClippingState& Other )

Functions

	Name	Description
bool	GetAlwaysClip()
EClippingMet...	GetClippingMethod()	Gets the type of clipping that is required by this clipping state.
bool	GetShouldIntersectParent()
bool	HasZeroArea()	Indicates if this clipping state has a zero size, aka is empty.
bool	IsPointInside ( const FVector2D& Point )	Is a point inside the clipping state?
void	SetDebuggingStateIndex ( int32 InStateIndex )	Set the state index that this clipping state originated from.

Operators

		Name	Description
	bool	operator== ( const FSlateClippingState& Other )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss