Class Texture_EX

constructor

• new Texture_EX(graphicsDevice: GraphicsDevice, options?: { addressU?: number; addressV?: number; addressW?: number; anisotropy?: number; compareFunc?: number; compareOnRead?: boolean; cubemap?: boolean; depth?: number; fixCubemapSeams?: boolean; flipY?: boolean; format?: number; height?: number; levels?: Uint8Array[]; magFilter?: number; minFilter?: number; mipmaps?: boolean; name?: string; premultiplyAlpha?: boolean; projection?: string; type?: string; volume?: boolean; width?: number }): Texture_EX

• Create a new Texture instance.

  Example

  // Create a 8x8x24-bit texture
  var texture = new pc.Texture(graphicsDevice, {
      width: 8,
      height: 8,
      format: pc.PIXELFORMAT_R8_G8_B8
  });
  
  // Fill the texture with a gradient
  var pixels = texture.lock();
  var count = 0;
  for (var i = 0; i < 8; i++) {
      for (var j = 0; j < 8; j++) {
          pixels[count++] = i * 32;
          pixels[count++] = j * 32;
          pixels[count++] = 255;
      }
  }
  texture.unlock();
  

  Parameters

  • graphicsDevice: GraphicsDevice

    The graphics device used to manage this texture.

  • Optional options: { addressU?: number; addressV?: number; addressW?: number; anisotropy?: number; compareFunc?: number; compareOnRead?: boolean; cubemap?: boolean; depth?: number; fixCubemapSeams?: boolean; flipY?: boolean; format?: number; height?: number; levels?: Uint8Array[]; magFilter?: number; minFilter?: number; mipmaps?: boolean; name?: string; premultiplyAlpha?: boolean; projection?: string; type?: string; volume?: boolean; width?: number }

    Object for passing optional arguments.

    • Optional addressU?: number

      The repeat mode to use in the U direction. Defaults to ADDRESS_REPEAT.

    • Optional addressV?: number

      The repeat mode to use in the V direction. Defaults to ADDRESS_REPEAT.

    • Optional addressW?: number

      The repeat mode to use in the W direction. Defaults to ADDRESS_REPEAT.

    • Optional anisotropy?: number

      The level of anisotropic filtering to use. Defaults to 1.

    • Optional compareFunc?: number

      Comparison function when compareOnRead is enabled (WebGL2 only). Can be:

      • FUNC_LESS
      • FUNC_LESSEQUAL
      • FUNC_GREATER
      • FUNC_GREATEREQUAL
      • FUNC_EQUAL
      • FUNC_NOTEQUAL

      Defaults to FUNC_LESS.

    • Optional compareOnRead?: boolean

      When enabled, and if texture format is PIXELFORMAT_DEPTH or PIXELFORMAT_DEPTHSTENCIL, hardware PCF is enabled for this texture, and you can get filtered results of comparison using texture() in your shader (WebGL2 only). Defaults to false.

    • Optional cubemap?: boolean

      Specifies whether the texture is to be a cubemap. Defaults to false.

    • Optional depth?: number

      The number of depth slices in a 3D texture (WebGL2 only). Defaults to 1 (single 2D image).

    • Optional fixCubemapSeams?: boolean

      Specifies whether this cubemap texture requires special seam fixing shader code to look right. Defaults to false.

    • Optional flipY?: boolean

      Specifies whether the texture should be flipped in the Y-direction. Only affects textures with a source that is an image, canvas or video element. Does not affect cubemaps, compressed textures or textures set from raw pixel data. Defaults to false.

    • Optional format?: number

      The pixel format of the texture. Can be:

      • PIXELFORMAT_A8
      • PIXELFORMAT_L8
      • PIXELFORMAT_L8_A8
      • PIXELFORMAT_R5_G6_B5
      • PIXELFORMAT_R5_G5_B5_A1
      • PIXELFORMAT_R4_G4_B4_A4
      • PIXELFORMAT_R8_G8_B8
      • PIXELFORMAT_R8_G8_B8_A8
      • PIXELFORMAT_DXT1
      • PIXELFORMAT_DXT3
      • PIXELFORMAT_DXT5
      • PIXELFORMAT_RGB16F
      • PIXELFORMAT_RGBA16F
      • PIXELFORMAT_RGB32F
      • PIXELFORMAT_RGBA32F
      • PIXELFORMAT_ETC1
      • PIXELFORMAT_PVRTC_2BPP_RGB_1
      • PIXELFORMAT_PVRTC_2BPP_RGBA_1
      • PIXELFORMAT_PVRTC_4BPP_RGB_1
      • PIXELFORMAT_PVRTC_4BPP_RGBA_1
      • PIXELFORMAT_111110F
      • PIXELFORMAT_ASTC_4x4>/li>
      • PIXELFORMAT_ATC_RGB
      • PIXELFORMAT_ATC_RGBA

      Defaults to PIXELFORMAT_R8_G8_B8_A8.

    • Optional height?: number

      The height of the texture in pixels. Defaults to 4.

    • Optional levels?: Uint8Array[]

      Array of Uint8Array.

    • Optional magFilter?: number

      The magnification filter type to use. Defaults to FILTER_LINEAR.

    • Optional minFilter?: number

      The minification filter type to use. Defaults to FILTER_LINEAR_MIPMAP_LINEAR.

    • Optional mipmaps?: boolean

      When enabled try to generate or use mipmaps for this texture. Default is true.

    • Optional name?: string

      The name of the texture.

    • Optional premultiplyAlpha?: boolean

      If true, the alpha channel of the texture (if present) is multiplied into the color channels. Defaults to false.

    • Optional projection?: string

      The projection type of the texture, used when the texture represents an environment. Can be:

      • TEXTUREPROJECTION_NONE
      • TEXTUREPROJECTION_CUBE
      • TEXTUREPROJECTION_EQUIRECT
      • TEXTUREPROJECTION_OCTAHEDRAL

      Defaults to TEXTUREPROJECTION_CUBE if options.cubemap is specified, otherwise TEXTUREPROJECTION_NONE.

    • Optional type?: string

      Specifies the image type, see TEXTURETYPE_DEFAULT.

    • Optional volume?: boolean

      Specifies whether the texture is to be a 3D volume (WebGL2 only). Defaults to false.

    • Optional width?: number

      The width of the texture in pixels. Defaults to 4.

  Returns Texture_EX