CubeMap

    Category: Core

    A CubeMap is a 6 sided 3D texture.

    Properties

    Enumerations

    enum Storage:

    • STORAGE_RAW = 0 — Store the without any compression.
    • STORAGE_COMPRESS_LOSSLESS = 2 — Store the CubeMap with moderate compression that doesn’t reduce image quality.
    • 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 .
    • SIDE_FRONT = 4 — Identifier for the front face of the CubeMap.
    • SIDE_BACK = 5 — Identifier for the back face of the CubeMap.

    enum Flags:

    • FLAG_MIPMAPS = 1 — Generate mipmaps, to enable smooth zooming out of the texture.
    • 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.

    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

    • flags

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

    • float lossy_storage_quality
    • storage_mode

    The ’s storage mode. See STORAGE_* constants.

    • int get_height ( ) const

    Returns the CubeMap’s height.

    • get_side ( Side side ) const

    Returns an for a side of the CubeMap using one of the SIDE_* constants or an integer 0-5.

    • int get_width ( ) const

    Sets an for a side of the using one of the SIDE_* constants or an integer 0-5.