.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/SpriteBase3D.xml. .. _class_SpriteBase3D: SpriteBase3D ============ **Inherits:** :ref:`GeometryInstance3D` **<** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`AnimatedSprite3D`, :ref:`Sprite3D` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`alpha_antialiasing_edge` | ``0.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`AlphaAntiAliasing` | :ref:`alpha_antialiasing_mode` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`AlphaCutMode` | :ref:`alpha_cut` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`alpha_hash_scale` | ``1.0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`alpha_scissor_threshold` | ``0.5`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | Vector3.Axis | :ref:`axis` | ``2`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`BillboardMode` | :ref:`billboard` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`centered` | ``true`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`double_sided` | ``true`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`fixed_size` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_h` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`flip_v` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`Color` | :ref:`modulate` | ``Color(1, 1, 1, 1)`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`no_depth_test` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`Vector2` | :ref:`offset` | ``Vector2(0, 0)`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`float` | :ref:`pixel_size` | ``0.01`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`int` | :ref:`render_priority` | ``0`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`shaded` | ``false`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`TextureFilter` | :ref:`texture_filter` | ``3`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ | :ref:`bool` | :ref:`transparent` | ``true`` | +-----------------------------------------------------------------+-------------------------------------------------------------------------------------+-----------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TriangleMesh` | :ref:`generate_triangle_mesh` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_draw_flag` **(** :ref:`DrawFlags` flag **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Rect2` | :ref:`get_item_rect` **(** **)** |const| | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_draw_flag` **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** | +-----------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_SpriteBase3D_DrawFlags: .. rst-class:: classref-enumeration enum **DrawFlags**: .. _class_SpriteBase3D_constant_FLAG_TRANSPARENT: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_TRANSPARENT** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_FLAG_SHADED: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_SHADED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_FLAG_DOUBLE_SIDED: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_DOUBLE_SIDED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_FLAG_DISABLE_DEPTH_TEST: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_DISABLE_DEPTH_TEST** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_FLAG_FIXED_SIZE: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_FIXED_SIZE** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_FLAG_MAX: .. rst-class:: classref-enumeration-constant :ref:`DrawFlags` **FLAG_MAX** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_SpriteBase3D_AlphaCutMode: .. rst-class:: classref-enumeration enum **AlphaCutMode**: .. _class_SpriteBase3D_constant_ALPHA_CUT_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`AlphaCutMode` **ALPHA_CUT_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_ALPHA_CUT_DISCARD: .. rst-class:: classref-enumeration-constant :ref:`AlphaCutMode` **ALPHA_CUT_DISCARD** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_ALPHA_CUT_OPAQUE_PREPASS: .. rst-class:: classref-enumeration-constant :ref:`AlphaCutMode` **ALPHA_CUT_OPAQUE_PREPASS** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_SpriteBase3D_constant_ALPHA_CUT_HASH: .. rst-class:: classref-enumeration-constant :ref:`AlphaCutMode` **ALPHA_CUT_HASH** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_SpriteBase3D_property_alpha_antialiasing_edge: .. rst-class:: classref-property :ref:`float` **alpha_antialiasing_edge** = ``0.0`` .. rst-class:: classref-property-setget - void **set_alpha_antialiasing_edge** **(** :ref:`float` value **)** - :ref:`float` **get_alpha_antialiasing_edge** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_alpha_antialiasing_mode: .. rst-class:: classref-property :ref:`AlphaAntiAliasing` **alpha_antialiasing_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_alpha_antialiasing** **(** :ref:`AlphaAntiAliasing` value **)** - :ref:`AlphaAntiAliasing` **get_alpha_antialiasing** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_alpha_cut: .. rst-class:: classref-property :ref:`AlphaCutMode` **alpha_cut** = ``0`` .. rst-class:: classref-property-setget - void **set_alpha_cut_mode** **(** :ref:`AlphaCutMode` value **)** - :ref:`AlphaCutMode` **get_alpha_cut_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_alpha_hash_scale: .. rst-class:: classref-property :ref:`float` **alpha_hash_scale** = ``1.0`` .. rst-class:: classref-property-setget - void **set_alpha_hash_scale** **(** :ref:`float` value **)** - :ref:`float` **get_alpha_hash_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_alpha_scissor_threshold: .. rst-class:: classref-property :ref:`float` **alpha_scissor_threshold** = ``0.5`` .. rst-class:: classref-property-setget - void **set_alpha_scissor_threshold** **(** :ref:`float` value **)** - :ref:`float` **get_alpha_scissor_threshold** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_axis: .. rst-class:: classref-property Vector3.Axis **axis** = ``2`` .. rst-class:: classref-property-setget - void **set_axis** **(** Vector3.Axis value **)** - Vector3.Axis **get_axis** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_billboard: .. rst-class:: classref-property :ref:`BillboardMode` **billboard** = ``0`` .. rst-class:: classref-property-setget - void **set_billboard_mode** **(** :ref:`BillboardMode` value **)** - :ref:`BillboardMode` **get_billboard_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_centered: .. rst-class:: classref-property :ref:`bool` **centered** = ``true`` .. rst-class:: classref-property-setget - void **set_centered** **(** :ref:`bool` value **)** - :ref:`bool` **is_centered** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_double_sided: .. rst-class:: classref-property :ref:`bool` **double_sided** = ``true`` .. rst-class:: classref-property-setget - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_fixed_size: .. rst-class:: classref-property :ref:`bool` **fixed_size** = ``false`` .. rst-class:: classref-property-setget - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_flip_h: .. rst-class:: classref-property :ref:`bool` **flip_h** = ``false`` .. rst-class:: classref-property-setget - void **set_flip_h** **(** :ref:`bool` value **)** - :ref:`bool` **is_flipped_h** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_flip_v: .. rst-class:: classref-property :ref:`bool` **flip_v** = ``false`` .. rst-class:: classref-property-setget - void **set_flip_v** **(** :ref:`bool` value **)** - :ref:`bool` **is_flipped_v** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_modulate: .. rst-class:: classref-property :ref:`Color` **modulate** = ``Color(1, 1, 1, 1)`` .. rst-class:: classref-property-setget - void **set_modulate** **(** :ref:`Color` value **)** - :ref:`Color` **get_modulate** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_no_depth_test: .. rst-class:: classref-property :ref:`bool` **no_depth_test** = ``false`` .. rst-class:: classref-property-setget - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_offset: .. rst-class:: classref-property :ref:`Vector2` **offset** = ``Vector2(0, 0)`` .. rst-class:: classref-property-setget - void **set_offset** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_offset** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_pixel_size: .. rst-class:: classref-property :ref:`float` **pixel_size** = ``0.01`` .. rst-class:: classref-property-setget - void **set_pixel_size** **(** :ref:`float` value **)** - :ref:`float` **get_pixel_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_render_priority: .. rst-class:: classref-property :ref:`int` **render_priority** = ``0`` .. rst-class:: classref-property-setget - void **set_render_priority** **(** :ref:`int` value **)** - :ref:`int` **get_render_priority** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_shaded: .. rst-class:: classref-property :ref:`bool` **shaded** = ``false`` .. rst-class:: classref-property-setget - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_texture_filter: .. rst-class:: classref-property :ref:`TextureFilter` **texture_filter** = ``3`` .. rst-class:: classref-property-setget - void **set_texture_filter** **(** :ref:`TextureFilter` value **)** - :ref:`TextureFilter` **get_texture_filter** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_property_transparent: .. rst-class:: classref-property :ref:`bool` **transparent** = ``true`` .. rst-class:: classref-property-setget - void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** - :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_SpriteBase3D_method_generate_triangle_mesh: .. rst-class:: classref-method :ref:`TriangleMesh` **generate_triangle_mesh** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_method_get_draw_flag: .. rst-class:: classref-method :ref:`bool` **get_draw_flag** **(** :ref:`DrawFlags` flag **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_method_get_item_rect: .. rst-class:: classref-method :ref:`Rect2` **get_item_rect** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SpriteBase3D_method_set_draw_flag: .. rst-class:: classref-method void **set_draw_flag** **(** :ref:`DrawFlags` flag, :ref:`bool` enabled **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`