unreal.SubUVAnimation

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

Bases: Object

SubUV animation asset, which caches bounding geometry for regions in the SubUVTexture with non-zero opacity. Particle emitters with a SubUV module which use this asset leverage the optimal bounding geometry to reduce overdraw.

C++ Source:

  • Module: Engine

  • File: SubUVAnimation.h

Editor Properties: (see get_editor_property/set_editor_property)

  • alpha_threshold (float): [Read-Write] Alpha channel values larger than the threshold are considered occupied and will be contained in the bounding geometry. Raising this threshold slightly can reduce overdraw in particles using this animation asset.

  • bounding_mode (SubUVBoundingVertexCount): [Read-Write] More bounding vertices results in reduced overdraw, but adds more triangle overhead. The eight vertex mode is best used when the SubUV texture has a lot of space to cut out that is not captured by the four vertex version, and when the particles using the texture will be few and large.

  • opacity_source_mode (OpacitySourceMode): [Read-Write]

  • sub_images_horizontal (int32): [Read-Write] The number of sub-images horizontally in the texture

  • sub_images_vertical (int32): [Read-Write] The number of sub-images vertically in the texture

  • sub_uv_texture (Texture2D): [Read-Write] Texture to generate bounding geometry from.