Version: 2023.2
LanguageEnglish
  • C#

CubemapArray Constructor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

Declaration

public CubemapArray(int width, int cubemapCount, TextureFormat textureFormat, bool mipChain);

Declaration

public CubemapArray(int width, int cubemapCount, TextureFormat textureFormat, bool mipChain, bool linear = false, bool createUninitialized = false);

Declaration

public CubemapArray(int width, int cubemapCount, TextureFormat textureFormat, int mipCount, bool linear);

Declaration

public CubemapArray(int width, int cubemapCount, TextureFormat textureFormat, int mipCount, bool linear, bool createUninitialized = false);

Parameters

cubemapCount Number of elements in the cubemap array.
linear Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false.
width Width of each cubemap face.
textureFormat Format of the cubemaps.
mipChain Should mipmaps be generated ?
mipCount Amount of mipmaps to generate.
createUninitialized Use this flag to create the texture with uninitialized data. When overriding all texels anyway, this can lead to improved performance and reduced memory usage.

Description

Create a new cubemap array.

Enable createUninitialized to make the texture reference uninitialized data (both on the CPU and GPU). When overriding all texels, this can lead to improved performance and reduced memory usage during construction. Note that sampling an uninitialized texture gives unpredictable values.

Usually you will want to set the colors of the cubemaps after creating it. Use SetPixels, SetPixels32 or Graphics.CopyTexture functions for that.

Note that this class does not support CubemapArray creation with a Crunch compression TextureFormat.