BakedLightmap

Prerendered indirect light map for a scene.

Baked lightmaps are an alternative workflow for adding indirect (or baked) lighting to a scene. Unlike the GIProbe approach, baked lightmaps work fine on low-end PCs and mobile devices as they consume almost no resources in run-time.

@GodotBaseClass

struct BakedLightmap {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(BakedLightmap other);

BakedLightmap opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static BakedLightmap _new();

enum BakeQuality;

enum BakeError;

enum Constants;

void setLightData(BakedLightmapData data);

Ref!BakedLightmapData getLightData();

void setBakeCellSize(double bake_cell_size);

double getBakeCellSize();

void setCaptureCellSize(double capture_cell_size);

double getCaptureCellSize();

void setBakeQuality(long bake_quality);

BakedLightmap.BakeQuality getBakeQuality();

void setBakeMode(long bake_mode);

BakedLightmap.BakeMode getBakeMode();

void setExtents(Vector3 extents);

Vector3 getExtents();

void setPropagation(double propagation);

double getPropagation();

void setEnergy(double energy);

double getEnergy();

void setHdr(bool hdr);

bool isHdr();

void setImagePath(StringArg0 image_path);

String getImagePath();

BakedLightmap.BakeError bake(GodotObject from_node, bool create_visual_debug);

void debugBake();

double bakeCellSize [@property getter];

double bakeCellSize [@property setter];

BakedLightmap.BakeQuality bakeQuality [@property getter];

long bakeQuality [@property setter];

BakedLightmap.BakeMode bakeMode [@property getter];

long bakeMode [@property setter];

double bakePropagation [@property getter];

double bakePropagation [@property setter];

double bakeEnergy [@property getter];

double bakeEnergy [@property setter];

bool bakeHdr [@property getter];

bool bakeHdr [@property setter];

Vector3 bakeExtents [@property getter];

Vector3 bakeExtents [@property setter];

double captureCellSize [@property getter];

double captureCellSize [@property setter];

String imagePath [@property getter];

String imagePath [@property setter];

BakedLightmapData lightData [@property getter];

BakedLightmapData lightData [@property setter];

}

Members

Aliases

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

Enums

BakeError enum BakeError
BakeMode enum BakeMode
BakeQuality enum BakeQuality
Constants enum Constants

Functions

bake BakedLightmap.BakeError bake(GodotObject from_node, bool create_visual_debug)
debugBake void debugBake()
getBakeCellSize double getBakeCellSize()
getBakeMode BakedLightmap.BakeMode getBakeMode()
getBakeQuality BakedLightmap.BakeQuality getBakeQuality()
getCaptureCellSize double getCaptureCellSize()
getEnergy double getEnergy()
getExtents Vector3 getExtents()
getImagePath String getImagePath()
getLightData Ref!BakedLightmapData getLightData()
getPropagation double getPropagation()
isHdr bool isHdr()
opAssign BakedLightmap opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(BakedLightmap 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.
setBakeCellSize void setBakeCellSize(double bake_cell_size)
setBakeMode void setBakeMode(long bake_mode)
setBakeQuality void setBakeQuality(long bake_quality)
setCaptureCellSize void setCaptureCellSize(double capture_cell_size)
setEnergy void setEnergy(double energy)
setExtents void setExtents(Vector3 extents)
setHdr void setHdr(bool hdr)
setImagePath void setImagePath(StringArg0 image_path)
setLightData void setLightData(BakedLightmapData data)
setPropagation void setPropagation(double propagation)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

bakeCellSize double bakeCellSize [@property getter]
double bakeCellSize [@property setter]: Grid subdivision size for lightmapper calculation. Default value of 0.25 will work for most cases. Increase for better lighting on small details or if your scene is very large.
bakeEnergy double bakeEnergy [@property getter]
double bakeEnergy [@property setter]
bakeExtents Vector3 bakeExtents [@property getter]
Vector3 bakeExtents [@property setter]: Size of affected area.
bakeHdr bool bakeHdr [@property getter]
bool bakeHdr [@property setter]: If true lightmap can capture light values greater than 1.0. Turning this off will result in a smaller lightmap. Default value:false.
bakeMode BakedLightmap.BakeMode bakeMode [@property getter]
long bakeMode [@property setter]: Lightmapping mode. See bakemode.
bakePropagation double bakePropagation [@property getter]
double bakePropagation [@property setter]
bakeQuality BakedLightmap.BakeQuality bakeQuality [@property getter]
long bakeQuality [@property setter]: Three quality modes are available. Higher quality requires more rendering time. See bakequality.
captureCellSize double captureCellSize [@property getter]
double captureCellSize [@property setter]: Grid size used for real-time capture information on dynamic objects. Cannot be larger than bakeCellSize.
imagePath String imagePath [@property getter]
String imagePath [@property setter]: Location where lightmaps will be saved.
lightData BakedLightmapData lightData [@property getter]
BakedLightmapData lightData [@property setter]: The calculated light data.

Static functions

_new BakedLightmap _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 bakedlightmap structs

BakedLightmap