SpriteBase3D

2D sprite node in 3D environment.

A node that displays 2D texture information in a 3D environment.

@GodotBaseClass

struct SpriteBase3D {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(SpriteBase3D other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static SpriteBase3D _new();

enum DrawFlags;

enum AlphaCutMode;

enum Constants;

void _imUpdate();

void _queueUpdate();

Ref!TriangleMesh generateTriangleMesh();

SpriteBase3D.AlphaCutMode getAlphaCutMode();

Vector3.Axis getAxis();

SpatialMaterial.BillboardMode getBillboardMode();

bool getDrawFlag(long flag);

Rect2 getItemRect();

Color getModulate();

Vector2 getOffset();

double getOpacity();

double getPixelSize();

bool isCentered();

bool isFlippedH();

bool isFlippedV();

void setAlphaCutMode(long mode);

void setAxis(long axis);

void setBillboardMode(long mode);

void setCentered(bool centered);

void setDrawFlag(long flag, bool enabled);

void setFlipH(bool flip_h);

void setFlipV(bool flip_v);

void setModulate(Color modulate);

void setOffset(Vector2 offset);

void setOpacity(double opacity);

void setPixelSize(double pixel_size);

SpriteBase3D.AlphaCutMode alphaCut [@property getter];

long alphaCut [@property setter];

Vector3.Axis axis [@property getter];

long axis [@property setter];

SpatialMaterial.BillboardMode billboard [@property getter];

long billboard [@property setter];

bool centered [@property getter];

bool centered [@property setter];

bool doubleSided [@property getter];

bool doubleSided [@property setter];

bool flipH [@property getter];

bool flipH [@property setter];

bool flipV [@property getter];

bool flipV [@property setter];

Color modulate [@property getter];

Color modulate [@property setter];

Vector2 offset [@property getter];

Vector2 offset [@property setter];

double opacity [@property getter];

double opacity [@property setter];

double pixelSize [@property getter];

double pixelSize [@property setter];

bool shaded [@property getter];

bool shaded [@property setter];

bool transparent [@property getter];

bool transparent [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

AlphaCutMode enum AlphaCutMode
Constants enum Constants
DrawFlags enum DrawFlags

Functions

_imUpdate void _imUpdate()
_queueUpdate void _queueUpdate()
generateTriangleMesh Ref!TriangleMesh generateTriangleMesh()
getAlphaCutMode SpriteBase3D.AlphaCutMode getAlphaCutMode()
getAxis Vector3.Axis getAxis()
getBillboardMode SpatialMaterial.BillboardMode getBillboardMode()
getDrawFlag bool getDrawFlag(long flag): Returns the value of the specified flag.
getItemRect Rect2 getItemRect(): Returns the rectangle representing this sprite.
getModulate Color getModulate()
getOffset Vector2 getOffset()
getOpacity double getOpacity()
getPixelSize double getPixelSize()
isCentered bool isCentered()
isFlippedH bool isFlippedH()
isFlippedV bool isFlippedV()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(SpriteBase3D other)
opEquals bool opEquals(typeof(null) n)
setAlphaCutMode void setAlphaCutMode(long mode)
setAxis void setAxis(long axis)
setBillboardMode void setBillboardMode(long mode)
setCentered void setCentered(bool centered)
setDrawFlag void setDrawFlag(long flag, bool enabled): If true, the specified flag will be enabled.
setFlipH void setFlipH(bool flip_h)
setFlipV void setFlipV(bool flip_v)
setModulate void setModulate(Color modulate)
setOffset void setOffset(Vector2 offset)
setOpacity void setOpacity(double opacity)
setPixelSize void setPixelSize(double pixel_size)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

alphaCut SpriteBase3D.AlphaCutMode alphaCut [@property getter]
long alphaCut [@property setter]
axis Vector3.Axis axis [@property getter]
long axis [@property setter]: The direction in which the front of the texture faces.
billboard SpatialMaterial.BillboardMode billboard [@property getter]
long billboard [@property setter]
centered bool centered [@property getter]
bool centered [@property setter]: If true, texture will be centered.
doubleSided bool doubleSided [@property getter]
bool doubleSided [@property setter]: If true, texture can be seen from the back as well, if false, it is invisible when looking at it from behind.
flipH bool flipH [@property getter]
bool flipH [@property setter]: If true, texture is flipped horizontally.
flipV bool flipV [@property getter]
bool flipV [@property setter]: If true, texture is flipped vertically.
modulate Color modulate [@property getter]
Color modulate [@property setter]: A color value that gets multiplied on, could be used for mood-coloring or to simulate the color of light.
offset Vector2 offset [@property getter]
Vector2 offset [@property setter]: The texture's drawing offset.
opacity double opacity [@property getter]
double opacity [@property setter]: The objects' visibility on a scale from 0 fully invisible to 1 fully visible.
pixelSize double pixelSize [@property getter]
double pixelSize [@property setter]: The size of one pixel's width on the sprite to scale it in 3D.
shaded bool shaded [@property getter]
bool shaded [@property setter]: If true, the Light in the Environment has effects on the sprite.
transparent bool transparent [@property getter]
bool transparent [@property setter]: If true, the texture's transparency and the opacity are used to make those parts of the sprite invisible.

Static functions

_new SpriteBase3D _new(): Construct a new instance of SpriteBase3D. Note: use memnew!SpriteBase3D instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot spritebase3d modules

all

structs

SpriteBase3D