SScissorRectBox

A ScissorRectBox is a widget that clips all its children using a scissor rect that matches it clipping rect in LAYOUT SPACE (the way it is provided in OnPaint).

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScissorRectBox.h

Include

#include "Widgets/Layout/SScissorRectBox.h"

Syntax

class SScissorRectBox : public SPanel

Remarks

A ScissorRectBox is a widget that clips all its children using a scissor rect that matches it clipping rect in LAYOUT SPACE (the way it is provided in OnPaint). This ensures that any child widgets with render transforms do not "bleed out" of this parent container.

there is a significant performance impact to using one of these widgets because any widgets inside this one end up in a separate set of batches using that scissor rect. Keep in mind that this widget will use the LAYOUT clipping rect to clip children, since hardware clipping rects do not support non-aligned rectangles. If a render transform is applied to this widget itself, the results will not be as expected.

This class is provided as a STOPGAP for design-time widgets (like the UMG designer itself) until a more robust clipping solution can be put in place.

Constructors

Name Description

Public function

SScissorRectBox()

Functions

Name Description

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Public function

void

 

SetContent

(
    const TSharedRef< SWidget >& InCon...
)

See the Content slot.

Classes

Name

Description

Public struct

FArguments

Public class

FScissorRectSlot

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