Sprite3D

2D sprite node in a 3D world.

A node that displays a 2D texture in a 3D environment. The texture displayed can be a region from a larger atlas texture, or a frame from a sprite sheet animation.

@GodotBaseClass

struct Sprite3D {

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(Sprite3D other);

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Sprite3D _new();

long getFrame();

Vector2 getFrameCoords();

long getHframes();

Rect2 getRegionRect();

Ref!Texture getTexture();

long getVframes();

bool isRegion();

void setFrame(long frame);

void setFrameCoords(Vector2 coords);

void setHframes(long hframes);

void setRegion(bool enabled);

void setRegionRect(Rect2 rect);

void setTexture(Texture texture);

void setVframes(long vframes);

long frame [@property getter];

long frame [@property setter];

Vector2 frameCoords [@property getter];

Vector2 frameCoords [@property setter];

long hframes [@property getter];

long hframes [@property setter];

bool regionEnabled [@property getter];

bool regionEnabled [@property setter];

Rect2 regionRect [@property getter];

Rect2 regionRect [@property setter];

Texture texture [@property getter];

Texture texture [@property setter];

long vframes [@property getter];

long vframes [@property setter];

}

Members

Aliases

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

Functions

getFrame long getFrame()
getFrameCoords Vector2 getFrameCoords()
getHframes long getHframes()
getRegionRect Rect2 getRegionRect()
getTexture Ref!Texture getTexture()
getVframes long getVframes()
isRegion bool isRegion()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Sprite3D other)
opEquals bool opEquals(typeof(null) n)
setFrame void setFrame(long frame)
setFrameCoords void setFrameCoords(Vector2 coords)
setHframes void setHframes(long hframes)
setRegion void setRegion(bool enabled)
setRegionRect void setRegionRect(Rect2 rect)
setTexture void setTexture(Texture texture)
setVframes void setVframes(long vframes)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

frame long frame [@property getter]
long frame [@property setter]: Current frame to display from sprite sheet. hframes or vframes must be greater than 1.
frameCoords Vector2 frameCoords [@property getter]
Vector2 frameCoords [@property setter]: Coordinates of the frame to display from sprite sheet. This is as an alias for the frame property. hframes or vframes must be greater than 1.
hframes long hframes [@property getter]
long hframes [@property setter]: The number of columns in the sprite sheet.
regionEnabled bool regionEnabled [@property getter]
bool regionEnabled [@property setter]: If true, texture will be cut from a larger atlas texture. See regionRect.
regionRect Rect2 regionRect [@property getter]
Rect2 regionRect [@property setter]: The region of the atlas texture to display. regionEnabled must be true.
texture Texture texture [@property getter]
Texture texture [@property setter]: Texture object to draw. If GeometryInstance.materialOverride is used, this will be overridden.
vframes long vframes [@property getter]
long vframes [@property setter]: The number of rows in the sprite sheet.

Static functions

_new Sprite3D _new(): Construct a new instance of Sprite3D. Note: use memnew!Sprite3D 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 sprite3d structs

Sprite3D