unreal.GeometryMaskCanvas

class unreal.GeometryMaskCanvas(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

A uniquely identified Canvas.

C++ Source:

  • Plugin: GeometryMask

  • Module: GeometryMask

  • File: GeometryMaskCanvas.h

Editor Properties: (see get_editor_property/set_editor_property)

  • apply_blur (bool): [Read-Write] Optional Blur Toggle.

  • apply_feather (bool): [Read-Write] Optional Feather Toggle.

  • blur_strength (double): [Read-Write] Optional Blur Strength.

  • canvas_name (Name): [Read-Only] Uniquely identifies this canvas.

  • inner_feather_radius (int32): [Read-Write] Optional Inner Feather Radius.

  • outer_feather_radius (int32): [Read-Write] Optional Outer Feather Radius.

property apply_blur: bool

[Read-Write] Optional Blur Toggle.

Type:

(bool)

property apply_feather: bool

[Read-Write] Optional Feather Toggle.

Type:

(bool)

property blur_strength: float

[Read-Write] Optional Blur Strength.

Type:

(double)

bp_get_render_target_slice_index() → int32

Get the index to the render target slice the canvas draws to

Return type:

int32

property canvas_name: Name

[Read-Only] Uniquely identifies this canvas.

Type:

(Name)

get_color_channel() → GeometryMaskColorChannel

Get Color Channel deprecated: Color channel has been deprecated in 5.8. Use GetRenderTargetSliceIndex and pass it into the R value in the Mask_TextureIndexVector color parameter. Rest of the values (GBA) should be -1

Return type:

GeometryMaskColorChannel

get_render_target() → TextureRenderTarget2DArray

Returns the render target 2D array that the canvas draws to

Return type:

TextureRenderTarget2DArray

get_texture() → CanvasRenderTarget2D

Get Texture deprecated: GetTexture (CanvasRenderTarget2D) has been deprecated. Use GetRenderTarget (TextureRenderTarget2DArray) and pass it into Mask_Textures parameter instead

Return type:

CanvasRenderTarget2D

property inner_feather_radius: int

[Read-Write] Optional Inner Feather Radius.

Type:

(int32)

property outer_feather_radius: int

[Read-Write] Optional Outer Feather Radius.

Type:

(int32)