Up to date

This page is up to date for Blazium 0.4.90 (4.3). If you still find outdated information, please open an issue.

Texture3D๏ƒ

Inherits: Texture < Resource < RefCounted < Object

Inherited By: CompressedTexture3D, ImageTexture3D, NoiseTexture3D, PlaceholderTexture3D, Texture3DRD

Base class for 3-dimensional textures.

Description๏ƒ

Base class for ImageTexture3D and CompressedTexture3D. Cannot be used directly, but contains all the functions necessary for accessing the derived resource types. Texture3D is the base class for all 3-dimensional texture types. See also TextureLayered.

All images need to have the same width, height and number of mipmap levels.

To create such a texture file yourself, reimport your image files using the Godot Editor import presets.

Methods๏ƒ

Array[Image]

_get_data() virtual const

int

_get_depth() virtual const

Format

_get_format() virtual const

int

_get_height() virtual const

int

_get_width() virtual const

bool

_has_mipmaps() virtual const

Resource

create_placeholder() const

Array[Image]

get_data() const

int

get_depth() const

Format

get_format() const

int

get_height() const

int

get_width() const

bool

has_mipmaps() const


Method Descriptions๏ƒ

Array[Image] _get_data() virtual const ๐Ÿ”—

Called when the Texture3D's data is queried.


int _get_depth() virtual const ๐Ÿ”—

Called when the Texture3D's depth is queried.


Format _get_format() virtual const ๐Ÿ”—

Called when the Texture3D's format is queried.


int _get_height() virtual const ๐Ÿ”—

Called when the Texture3D's height is queried.


int _get_width() virtual const ๐Ÿ”—

Called when the Texture3D's width is queried.


bool _has_mipmaps() virtual const ๐Ÿ”—

Called when the presence of mipmaps in the Texture3D is queried.


Resource create_placeholder() const ๐Ÿ”—

Creates a placeholder version of this resource (PlaceholderTexture3D).


Array[Image] get_data() const ๐Ÿ”—

Returns the Texture3D's data as an array of Images. Each Image represents a slice of the Texture3D, with different slices mapping to different depth (Z axis) levels.


int get_depth() const ๐Ÿ”—

Returns the Texture3D's depth in pixels. Depth is typically represented by the Z axis (a dimension not present in Texture2D).


Format get_format() const ๐Ÿ”—

Returns the current format being used by this texture. See Format for details.


int get_height() const ๐Ÿ”—

Returns the Texture3D's height in pixels. Width is typically represented by the Y axis.


int get_width() const ๐Ÿ”—

Returns the Texture3D's width in pixels. Width is typically represented by the X axis.


bool has_mipmaps() const ๐Ÿ”—

Returns true if the Texture3D has generated mipmaps.