GeometryInstance

Base node for geometry-based visual instances.

Shares some common functionality like visibility and custom materials.

@GodotBaseClass

struct GeometryInstance {

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

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static GeometryInstance _new();

enum ShadowCastingSetting;

enum LightmapScale;

enum Constants;

GeometryInstance.ShadowCastingSetting getCastShadowsSetting();

double getExtraCullMargin();

bool getFlag(long flag);

bool getGenerateLightmap();

GeometryInstance.LightmapScale getLightmapScale();

double getLodMaxDistance();

double getLodMaxHysteresis();

double getLodMinDistance();

double getLodMinHysteresis();

Ref!Material getMaterialOverride();

void setCastShadowsSetting(long shadow_casting_setting);

void setCustomAabb(AABB aabb);

void setExtraCullMargin(double margin);

void setFlag(long flag, bool value);

void setGenerateLightmap(bool enabled);

void setLightmapScale(long scale);

void setLodMaxDistance(double mode);

void setLodMaxHysteresis(double mode);

void setLodMinDistance(double mode);

void setLodMinHysteresis(double mode);

void setMaterialOverride(Material material);

GeometryInstance.ShadowCastingSetting castShadow [@property getter];

long castShadow [@property setter];

double extraCullMargin [@property getter];

double extraCullMargin [@property setter];

bool generateLightmap [@property getter];

bool generateLightmap [@property setter];

GeometryInstance.LightmapScale lightmapScale [@property getter];

long lightmapScale [@property setter];

double lodMaxDistance [@property getter];

double lodMaxDistance [@property setter];

double lodMaxHysteresis [@property getter];

double lodMaxHysteresis [@property setter];

double lodMinDistance [@property getter];

double lodMinDistance [@property setter];

double lodMinHysteresis [@property getter];

double lodMinHysteresis [@property setter];

bool useInBakedLight [@property getter];

bool useInBakedLight [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
Flags enum Flags
LightmapScale enum LightmapScale
ShadowCastingSetting enum ShadowCastingSetting

Functions

getCastShadowsSetting GeometryInstance.ShadowCastingSetting getCastShadowsSetting()
getExtraCullMargin double getExtraCullMargin()
getFlag bool getFlag(long flag): Returns the GeometryInstance.flags that have been set for this object.
getGenerateLightmap bool getGenerateLightmap()
getLightmapScale GeometryInstance.LightmapScale getLightmapScale()
getLodMaxDistance double getLodMaxDistance()
getLodMaxHysteresis double getLodMaxHysteresis()
getLodMinDistance double getLodMinDistance()
getLodMinHysteresis double getLodMinHysteresis()
getMaterialOverride Ref!Material getMaterialOverride()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(GeometryInstance other)
opEquals bool opEquals(typeof(null) n)
setCastShadowsSetting void setCastShadowsSetting(long shadow_casting_setting)
setCustomAabb void setCustomAabb(AABB aabb): Overrides the bounding box of this node with a custom one. To remove it, set an AABB with all fields set to zero.
setExtraCullMargin void setExtraCullMargin(double margin)
setFlag void setFlag(long flag, bool value): Sets the GeometryInstance.flags specified. See GeometryInstance.flags for options.
setGenerateLightmap void setGenerateLightmap(bool enabled)
setLightmapScale void setLightmapScale(long scale)
setLodMaxDistance void setLodMaxDistance(double mode)
setLodMaxHysteresis void setLodMaxHysteresis(double mode)
setLodMinDistance void setLodMinDistance(double mode)
setLodMinHysteresis void setLodMinHysteresis(double mode)
setMaterialOverride void setMaterialOverride(Material material)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

castShadow GeometryInstance.ShadowCastingSetting castShadow [@property getter]
long castShadow [@property setter]: The selected shadow casting flag. See shadowcastingsetting for possible values.
extraCullMargin double extraCullMargin [@property getter]
double extraCullMargin [@property setter]: The extra distance added to the GeometryInstance's bounding box (AABB) to increase its cull box.
generateLightmap bool generateLightmap [@property getter]
bool generateLightmap [@property setter]: When disabled, the mesh will be taken into account when computing indirect lighting, but the resulting lightmap will not be saved. Useful for emissive only materials or shadow casters.
lightmapScale GeometryInstance.LightmapScale lightmapScale [@property getter]
long lightmapScale [@property setter]: Scale factor for the generated baked lightmap. Useful for adding detail to certain mesh instances.
lodMaxDistance double lodMaxDistance [@property getter]
double lodMaxDistance [@property setter]: The GeometryInstance's max LOD distance. Note: This property currently has no effect.
lodMaxHysteresis double lodMaxHysteresis [@property getter]
double lodMaxHysteresis [@property setter]: The GeometryInstance's max LOD margin. Note: This property currently has no effect.
lodMinDistance double lodMinDistance [@property getter]
double lodMinDistance [@property setter]: The GeometryInstance's min LOD distance. Note: This property currently has no effect.
lodMinHysteresis double lodMinHysteresis [@property getter]
double lodMinHysteresis [@property setter]: The GeometryInstance's min LOD margin. Note: This property currently has no effect.
useInBakedLight bool useInBakedLight [@property getter]
bool useInBakedLight [@property setter]: If true, this GeometryInstance will be used when baking lights using a GIProbe or BakedLightmap.

Static functions

_new GeometryInstance _new(): Construct a new instance of GeometryInstance. Note: use memnew!GeometryInstance 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 geometryinstance modules

all

structs

GeometryInstance