Documentation
¶
Overview ¶
graphics.gd/classdb/VoxelGIData contains baked voxel global illumination for use in a graphics.gd/classdb/VoxelGI node. graphics.gd/classdb/VoxelGIData also offers several properties to adjust the final appearance of the global illumination. These properties can be adjusted at run-time without having to bake the graphics.gd/classdb/VoxelGI node again.
Note: To prevent text-based scene files (.tscn) from growing too much and becoming slow to load and save, always save graphics.gd/classdb/VoxelGIData to an external binary resource file (.res) instead of embedding it within the scene. This can be done by clicking the dropdown arrow next to the graphics.gd/classdb/VoxelGIData resource, choosing Edit, clicking the floppy disk icon at the top of the Inspector then choosing Save As....
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) Allocate(to_cell_xform Transform3D.BasisOrigin, aabb AABB.PositionSize, ...)
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsVoxelGIData() Instance
- func (self Instance) Bias() Float.X
- func (self Instance) DynamicRange() Float.X
- func (self Instance) Energy() Float.X
- func (self Instance) GetBounds() AABB.PositionSize
- func (self Instance) GetDataCells() []byte
- func (self Instance) GetLevelCounts() []int32
- func (self Instance) GetOctreeCells() []byte
- func (self Instance) GetOctreeSize() Vector3.XYZ
- func (self Instance) GetToCellXform() Transform3D.BasisOrigin
- func (self Instance) ID() ID
- func (self Instance) Interior() bool
- func (self Instance) NormalBias() Float.X
- func (self Instance) Propagation() Float.X
- func (self Instance) SetBias(value Float.X)
- func (self Instance) SetDynamicRange(value Float.X)
- func (self Instance) SetEnergy(value Float.X)
- func (self Instance) SetInterior(value bool)
- func (self Instance) SetNormalBias(value Float.X)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetPropagation(value Float.X)
- func (self Instance) SetUseTwoBounces(value bool)
- func (self Instance) UseTwoBounces() bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsVoxelGIData ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.VoxelGIData
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) Allocate ¶
func (self Instance) Allocate(to_cell_xform Transform3D.BasisOrigin, aabb AABB.PositionSize, octree_size Vector3.XYZ, octree_cells []byte, data_cells []byte, distance_field []byte, level_counts []int32)
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsVoxelGIData ¶
func (Instance) DynamicRange ¶
func (Instance) GetBounds ¶
func (self Instance) GetBounds() AABB.PositionSize
Returns the bounds of the baked voxel data as an [AABB.PositionSize], which should match graphics.gd/classdb/VoxelGI.Instance.Size after being baked (which only contains the size as a [Vector3.XYZ]).
Note: If the size was modified without baking the VoxelGI data, then the value of Instance.GetBounds and graphics.gd/classdb/VoxelGI.Instance.Size will not match.
func (Instance) GetDataCells ¶
func (Instance) GetLevelCounts ¶
func (Instance) GetOctreeCells ¶
func (Instance) GetOctreeSize ¶
func (Instance) GetToCellXform ¶
func (self Instance) GetToCellXform() Transform3D.BasisOrigin
Source Files