FPaintGeometry

A Paint geometry contains the window-space (draw-space) info to draw an element on the screen.

Choose your operating system:

Windows

macOS

Linux

References

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

Syntax

struct FPaintGeometry

Remarks

A Paint geometry contains the window-space (draw-space) info to draw an element on the screen.

It contains the size of the element in the element's local space along with the transform needed to position the element in window space.

DrawPosition/DrawSize/DrawScale are maintained for legacy reasons, but are deprecated: The DrawPosition and DrawSize are already positioned and scaled for immediate consumption by the draw code.

The DrawScale is only applied to the internal aspects of the draw primitives. e.g. Line thickness, 3x3 grid margins, etc.

Variables

		Name	Description
	FVector2f	DrawPosition	!!! DEPRECATED!!! Drawing should only happen in local space to ensure render transforms work.
	float	DrawScale	!!! DEPRECATED!!! Drawing should only happen in local space to ensure render transforms work.

Constructors

	Name	Description
	FPaintGeometry()	Default ctor.
	FPaintGeometry ( FVector2D InDrawPosition, FVector2D InDrawSize, float InDrawScale )	!!! DEPRECATED!!! This is legacy and should be removed!
	FPaintGeometry ( const FSlateLayoutTransform& InAcc..., const FSlateRenderTransform& InAcc..., const FVector2D& InLocalSize, bool bInHasRenderTransform )	Creates and initializes a new instance.

Functions

	Name	Description
void	AppendTransform ( const FSlateLayoutTransform& Layou... )	Special case method to append a layout transform to a paint geometry.
void	CommitTransformsIfUsingLegacyConstructor()	Support mutable geometries constructed in window space, and possibly mutated later, as all legacy members are public.
const FSlate...	GetAccumulatedRenderTransform()	Access the final render transform.
const FVecto...	GetLocalSize()	Get the Size of the geometry in local space.
bool	HasRenderTransform()
void	SetRenderTransform ( const FSlateRenderTransform& Rende... )	Special case method to replace the render transform on a paint geometry.