OmniLight

Omnidirectional light, such as a light bulb or a candle.

An Omnidirectional light is a type of Light that emits light in all directions. The light is attenuated by distance and this attenuation can be configured by changing its energy, radius, and attenuation parameters. Note: By default, only 32 OmniLights may affect a single mesh resource at once. Consider splitting your level into several meshes to decrease the likelihood that more than 32 lights will affect the same mesh resource. Splitting the level mesh will also improve frustum culling effectiveness, leading to greater performance. If you need to use more lights per mesh, you can increase ProjectSettings.rendering/limits/rendering/maxLightsPerObject at the cost of shader compilation times.

@GodotBaseClass

struct OmniLight {

package

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

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

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static OmniLight _new();

enum ShadowMode;

enum ShadowDetail;

enum Constants;

OmniLight.ShadowDetail getShadowDetail();

OmniLight.ShadowMode getShadowMode();

void setShadowDetail(long detail);

void setShadowMode(long mode);

double omniAttenuation [@property getter];

double omniAttenuation [@property setter];

double omniRange [@property getter];

double omniRange [@property setter];

OmniLight.ShadowDetail omniShadowDetail [@property getter];

long omniShadowDetail [@property setter];

OmniLight.ShadowMode omniShadowMode [@property getter];

long omniShadowMode [@property setter];

}

Members

Aliases

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

Enums

Constants enum Constants
ShadowDetail enum ShadowDetail
ShadowMode enum ShadowMode

Functions

getShadowDetail OmniLight.ShadowDetail getShadowDetail()
getShadowMode OmniLight.ShadowMode getShadowMode()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(OmniLight other)
opEquals bool opEquals(typeof(null) n)
setShadowDetail void setShadowDetail(long detail)
setShadowMode void setShadowMode(long mode)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

omniAttenuation double omniAttenuation [@property getter]
double omniAttenuation [@property setter]: The light's attenuation (drop-off) curve. A number of presets are available in the Inspector by right-clicking the curve.
omniRange double omniRange [@property getter]
double omniRange [@property setter]: The light's radius. Note that the effectively lit area may appear to be smaller depending on the omniAttenuation in use. No matter the omniAttenuation in use, the light will never reach anything outside this radius.
omniShadowDetail OmniLight.ShadowDetail omniShadowDetail [@property getter]
long omniShadowDetail [@property setter]: See shadowdetail.
omniShadowMode OmniLight.ShadowMode omniShadowMode [@property getter]
long omniShadowMode [@property setter]: See shadowmode.

Static functions

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

OmniLight

Members

Aliases

Enums

Functions

Mixins

Properties

Static functions

Static variables

Structs

Unions

Variables

Mixed In Members

From `mixin baseCasts`

Meta

Source

OmniLight

From mixin baseCasts

From `mixin baseCasts`