Documentation
¶
Overview ¶
A cubemap is made of 6 textures organized in layers. They are typically used for faking reflections in 3D rendering (see graphics.gd/classdb/ReflectionProbe). It can be used to make an object look as if it's reflecting its surroundings. This usually delivers much better performance than other reflection methods.
This resource is typically used as a uniform in custom shaders. Few core Godot methods make use of graphics.gd/classdb/Cubemap resources.
To create such a texture file yourself, reimport your image files using the Godot Editor import presets. To create a Cubemap from code, use graphics.gd/classdb/ImageTextureLayered.Instance.CreateFromImages on an instance of the Cubemap class.
The expected image order is X+, X-, Y+, Y-, Z+, Z- (in Godot's coordinate system, so Y+ is "up" and Z- is "forward"). You can use one of the following templates as a base:
- 2×3 cubemap template (default layout option)
Note: Godot doesn't support using cubemaps in a graphics.gd/classdb/PanoramaSkyMaterial. To use a cubemap as a skybox, convert the default graphics.gd/classdb/PanoramaSkyMaterial to a graphics.gd/classdb/ShaderMaterial using the Convert to ShaderMaterial resource dropdown option, then replace its code with the following:
After replacing the shader code and saving, specify the imported Cubemap resource in the Shader Parameters section of the ShaderMaterial in the inspector.
Alternatively, you can use this tool to convert a cubemap to an equirectangular sky map and use graphics.gd/classdb/PanoramaSkyMaterial as usual.
Index ¶
- type Advanced
- type Any
- type Extension
- func (self *Extension[T]) AsCubemap() Instance
- func (self *Extension[T]) AsImageTextureLayered() ImageTextureLayered.Instance
- func (self *Extension[T]) AsObject() [1]gd.Object
- func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
- func (self *Extension[T]) AsResource() Resource.Instance
- func (self *Extension[T]) AsTexture() Texture.Instance
- func (self *Extension[T]) AsTextureLayered() TextureLayered.Instance
- type ID
- type Instance
- func (self Instance) AsCubemap() Instance
- func (self Instance) AsImageTextureLayered() ImageTextureLayered.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsRefCounted() [1]gd.RefCounted
- func (self Instance) AsResource() Resource.Instance
- func (self Instance) AsTexture() Texture.Instance
- func (self Instance) AsTextureLayered() TextureLayered.Instance
- func (self Instance) CreatePlaceholder() Resource.Instance
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) 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]) AsImageTextureLayered ¶
func (self *Extension[T]) AsImageTextureLayered() ImageTextureLayered.Instance
func (*Extension[T]) AsRefCounted ¶
func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted
func (*Extension[T]) AsResource ¶
func (*Extension[T]) AsTextureLayered ¶
func (self *Extension[T]) AsTextureLayered() TextureLayered.Instance
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 ¶
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) AsImageTextureLayered ¶
func (self Instance) AsImageTextureLayered() ImageTextureLayered.Instance
func (Instance) AsRefCounted ¶
func (self Instance) AsRefCounted() [1]gd.RefCounted
func (Instance) AsResource ¶
func (Instance) AsTextureLayered ¶
func (self Instance) AsTextureLayered() TextureLayered.Instance
func (Instance) CreatePlaceholder ¶
Creates a placeholder version of this resource (graphics.gd/classdb/PlaceholderCubemap).
Source Files
