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);

bool opEquals(SpriteBase3D other);

SpriteBase3D opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static SpriteBase3D _new();

enum DrawFlags;

enum AlphaCutMode;

enum Constants;

void setCentered(bool centered);

bool isCentered();

void setOffset(Vector2 offset);

Vector2 getOffset();

void setFlipH(bool flip_h);

bool isFlippedH();

void setFlipV(bool flip_v);

bool isFlippedV();

void setModulate(Color modulate);

Color getModulate();

void setOpacity(double opacity);

double getOpacity();

void setPixelSize(double pixel_size);

double getPixelSize();

void setAxis(long axis);

Vector3.Axis getAxis();

void setDrawFlag(long flag, bool enabled);

bool getDrawFlag(long flag);

void setAlphaCutMode(long mode);

SpriteBase3D.AlphaCutMode getAlphaCutMode();

Rect2 getItemRect();

Ref!TriangleMesh generateTriangleMesh();

void _queueUpdate();

void _imUpdate();

bool centered [@property getter];

bool centered [@property setter];

Vector2 offset [@property getter];

Vector2 offset [@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];

double opacity [@property getter];

double opacity [@property setter];

double pixelSize [@property getter];

double pixelSize [@property setter];

Vector3.Axis axis [@property getter];

long axis [@property setter];

bool transparent [@property getter];

bool transparent [@property setter];

bool shaded [@property getter];

bool shaded [@property setter];

bool doubleSided [@property getter];

bool doubleSided [@property setter];

SpriteBase3D.AlphaCutMode alphaCut [@property getter];

long alphaCut [@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()
getDrawFlag bool getDrawFlag(long flag)
getItemRect Rect2 getItemRect()
getModulate Color getModulate()
getOffset Vector2 getOffset()
getOpacity double getOpacity()
getPixelSize double getPixelSize()
isCentered bool isCentered()
isFlippedH bool isFlippedH()
isFlippedV bool isFlippedV()
opAssign SpriteBase3D opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(SpriteBase3D other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setAlphaCutMode void setAlphaCutMode(long mode)
setAxis void setAxis(long axis)
setCentered void setCentered(bool centered)
setDrawFlag void setDrawFlag(long flag, bool 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)

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.
centered bool centered [@property getter]
bool centered [@property setter]: If true texture will be centered. Default value: true.
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. Default value: true.
flipH bool flipH [@property getter]
bool flipH [@property setter]: If true texture is flipped horizontally. Default value: false.
flipV bool flipV [@property getter]
bool flipV [@property setter]: If true texture is flipped vertically. Default value: false.
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. Default value: false.
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. Default value: true.

Static functions

_new SpriteBase3D _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: 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 To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as 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