godot-docs/classes/class_cubemap.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CubeMap.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_CubeMap:

CubeMap
=======

**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

A CubeMap is a 6 sided 3D texture.

Properties
----------

+--------------------------------------+-------------------------------------------------------------------+
| :ref:`int<class_int>`                | :ref:`flags<class_CubeMap_flags>`                                 |
+--------------------------------------+-------------------------------------------------------------------+
| :ref:`float<class_float>`            | :ref:`lossy_storage_quality<class_CubeMap_lossy_storage_quality>` |
+--------------------------------------+-------------------------------------------------------------------+
| :ref:`Storage<enum_CubeMap_Storage>` | :ref:`storage_mode<class_CubeMap_storage_mode>`                   |
+--------------------------------------+-------------------------------------------------------------------+

Methods
-------

+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`get_height<class_CubeMap_get_height>` **(** **)** const                                                            |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`Image<class_Image>`  | :ref:`get_side<class_CubeMap_get_side>` **(** :ref:`Side<enum_CubeMap_Side>` side **)** const                            |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`      | :ref:`get_width<class_CubeMap_get_width>` **(** **)** const                                                              |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void                       | :ref:`set_side<class_CubeMap_set_side>` **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)** |
+----------------------------+--------------------------------------------------------------------------------------------------------------------------+

Enumerations
------------

.. _enum_CubeMap_Flags:

enum **Flags**:

- **FLAG_MIPMAPS** = **1** --- Generate mipmaps, to enable smooth zooming out of the texture.

- **FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).

- **FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.

- **FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.

.. _enum_CubeMap_Storage:

enum **Storage**:

- **STORAGE_RAW** = **0** --- Store the ``CubeMap`` without any compression.

- **STORAGE_COMPRESS_LOSSY** = **1** --- Store the ``CubeMap`` with strong compression that reduces image quality.

- **STORAGE_COMPRESS_LOSSLESS** = **2** --- Store the ``CubeMap`` with moderate compression that doesn't reduce image quality.

.. _enum_CubeMap_Side:

enum **Side**:

- **SIDE_LEFT** = **0** --- Identifier for the left face of the ``CubeMap``.

- **SIDE_RIGHT** = **1** --- Identifier for the right face of the ``CubeMap``.

- **SIDE_BOTTOM** = **2** --- Identifier for the bottom face of the ``CubeMap``.

- **SIDE_TOP** = **3** --- Identifier for the top face of the ``CubeMap``.

- **SIDE_FRONT** = **4** --- Identifier for the front face of the ``CubeMap``.

- **SIDE_BACK** = **5** --- Identifier for the back face of the ``CubeMap``.

Description
-----------

A 6-sided 3D texture typically used for faking reflections. 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.

Property Descriptions
---------------------

.. _class_CubeMap_flags:

- :ref:`int<class_int>` **flags**

+----------+------------------+
| *Setter* | set_flags(value) |
+----------+------------------+
| *Getter* | get_flags()      |
+----------+------------------+

The render flags for the ``CubeMap``. See the ``FLAG_*`` constants for details.

.. _class_CubeMap_lossy_storage_quality:

- :ref:`float<class_float>` **lossy_storage_quality**

+----------+----------------------------------+
| *Setter* | set_lossy_storage_quality(value) |
+----------+----------------------------------+
| *Getter* | get_lossy_storage_quality()      |
+----------+----------------------------------+

The lossy storage quality of the ``CubeMap`` if the storage mode is set to STORAGE_COMPRESS_LOSSY.

.. _class_CubeMap_storage_mode:

- :ref:`Storage<enum_CubeMap_Storage>` **storage_mode**

+----------+--------------------+
| *Setter* | set_storage(value) |
+----------+--------------------+
| *Getter* | get_storage()      |
+----------+--------------------+

The ``CubeMap``'s storage mode. See ``STORAGE_*`` constants.

Method Descriptions
-------------------

.. _class_CubeMap_get_height:

- :ref:`int<class_int>` **get_height** **(** **)** const

Returns the ``CubeMap``'s height.

.. _class_CubeMap_get_side:

- :ref:`Image<class_Image>` **get_side** **(** :ref:`Side<enum_CubeMap_Side>` side **)** const

Returns an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5.

.. _class_CubeMap_get_width:

- :ref:`int<class_int>` **get_width** **(** **)** const

Returns the ``CubeMap``'s width.

.. _class_CubeMap_set_side:

- void **set_side** **(** :ref:`Side<enum_CubeMap_Side>` side, :ref:`Image<class_Image>` image **)**

Sets an :ref:`Image<class_Image>` for a side of the ``CubeMap`` using one of the ``SIDE_*`` constants or an integer 0-5.