The TexturesModule
class enables images, animation sequences, videos, colors, and other visual artifacts to be combined to form materials.
//============================================================================== // The following example demonstrates how to access a texture in the Assets and // assign it to a material. // // Project setup: // - Insert a plane // - Create a material // - Import an image to use as a texture (renaming it texture0) // - Assign the material to the plane //============================================================================== // Load in the required modules const Materials = require('Materials'); const Textures = require('Textures'); // Enable async/await in JS [part 1] (async function() { // Locate the material and texture in the Assets const [material, texture] = await Promise.all([ Materials.findFirst('defaultMaterial0'), Textures.findFirst('texture0') ]); // Assign the texture to the material material.diffuse = texture; // Enable async/await in JS [part 2] })();
This module exposes no properties.
Method | Description |
---|---|
findFirst | findFirst(textureName: string): Promise<TextureBase | null> Returns a promise that is resolved with the texture of a requested name or null if none was found. See Also: Textures.findUsingPattern , Textures.getAll . |
findUsingPattern | findUsingPattern(namePattern: string, config?: {limit: number}): Promise<Array<TextureBase>> Returns a promise that is resolved with the all of the textures matching the name pattern or empty array if none was found. Pattern format: * matches any characters sequence.\ can be used to include in pattern any of the control characters (including '\' itself)Examples: findUsingPattern("*") will retrive all of the textures.findUsingPattern("*A") will retrieve all of the textures suffixed with 'A'.findUsingPattern("A*") will retrieve all of the textures prefixed with 'A'.findUsingPattern("*A*", {limit: 10}) will retrieve at most 10 of the textures containing 'A',limit parameter describes if findUsingPattern should finish the search if it finds specified number of results (default is no limit). Non-positive values for limit are treated as unlimited.See Also: Textures.getAll , Textures.findFirst . |
getAll | getAll(): Promise<Array<TextureBase>> Returns a promise that is resolved with all of the textures. See Also: Textures.findUsingPattern , Textures.findFirst . |
Class | Description |
---|---|
CameraTexture | The CameraTexture class represents a texture type that contains image data coming in from system camera, or captured photo/video in case of using the effect with "Media Library". |
CanvasTexture | The CanvasTexture class enables painting with a brush to a texture. |
ColorTexture | The ColorTexture class encapsulates a texture that has a color (including alpha channel). |
DeepLinkTexture | The DeepLinkTexture class represents an image texture passed in via the sharing SDK. |
GalleryTexture | The GalleryTexture class encapsulates a texture that was picked from the gallery. |
GalleryTextureMediaBase | GalleryTextureMediaBase is a base class for different types of media that can be selected from gallery and used in a gallery texture. |
GalleryTextureMediaImage | GalleryTextureMediaImage represents image media that was picked from the gallery that is being used by a given GalleryTexture. |
GalleryTextureMediaVideo | GalleryTextureMediaVideo represents "video" media that was picked from the gallery that is being used by a given GalleryTexture.It exposes a set of APIs that are specifically tailored for controlling video playback. |
ImageTexture | The ImageTexture class encapsulates an image that may be used to form materials for rendering in the scene. |
SegmentationTexture | The SegmentationTexture class encapsulates a texture that will be used for image segmentation. |
SequenceTexture | The SequenceTexture class is a collection of still images that form an animation. |
SourceImageRegionTexture | The SourceImageRegionTexture class. |
SubTexture | The SubTexture class exposes details of a texture in UV coordinates. |
TextureBase | The TextureBase class describes a texture. |