SpriteBase3D

    Inherited By: , Sprite3D

    Category: Core

    2D Sprite node in 3D environment.

    Properties

    generate_triangle_mesh ( ) const
    get_item_rect ( ) const

    Enumerations

    enum DrawFlags:

    • FLAG_TRANSPARENT = 0 — If set, the texture’s transparency and the opacity are used to make those parts of the Sprite invisible.
    • FLAG_DOUBLE_SIDED = 2 — If set, texture can be seen from the back as well, if not, it is invisible when looking at it from behind.
    • FLAG_MAX = 3 — Represents the size of the enum.

    enum AlphaCutMode:

    • ALPHA_CUT_DISABLED = 0
    • ALPHA_CUT_DISCARD = 1
    • ALPHA_CUT_OPAQUE_PREPASS = 2

    Property Descriptions

    Setterset_alpha_cut_mode(value)
    Getterget_alpha_cut_mode()
    • Vector3.Axis axis
    Setterset_axis(value)
    Getterget_axis()

    The direction in which the front of the texture faces.

    • centered

    If , texture will be centered. Default value: true.

    Setterset_draw_flag(value)
    Getterget_draw_flag()

    If true, texture can be seen from the back as well, if false, it is invisible when looking at it from behind. Default value: true.

    Setterset_flip_h(value)
    Getteris_flipped_h()

    If , texture is flipped horizontally. Default value: false.

    • flip_v
    Setterset_flip_v(value)
    Getteris_flipped_v()

    If true, texture is flipped vertically. Default value: false.

    • offset
    Setterset_offset(value)
    Getterget_offset()

    The texture’s drawing offset.

    Setterset_opacity(value)
    Getterget_opacity()

    The objects visibility on a scale from 0 fully invisible to fully visible.

    • pixel_size
    Setterset_pixel_size(value)
    Getterget_pixel_size()

    The size of one pixel’s width on the Sprite to scale it in 3D.

    If true, the in the Environment has effects on the Sprite. Default value: false.

    • transparent
    Setterset_draw_flag(value)
    Getterget_draw_flag()

    If true, the texture’s transparency and the opacity are used to make those parts of the Sprite invisible. Default value: true.

    • Rect2 get_item_rect ( ) const