Skip to main content

RectCropTextureProvider

Class

Texture Provider providing a cropped region of the input texture.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Texture Provider providing a cropped region of the input texture. The region is specified by the cropRect in local space and rotation. Can be accessed using Texture.control on a RectCropTexture asset, such as a Screen Crop Texture. For more information, see the Crop Textures guide.

Index

Example

// @input Asset.Texture screenCropTexture

// Zoom in
script.screenCropTexture.control.cropRect = Rect.create(-.5, .5, -.5, .5);

// Rotate by 90 degrees
script.screenCropTexture.control.rotation = Math.PI * .5;

Extends

Properties

cropRect

cropRect: Rect

The cropped region to draw.


inputTexture

inputTexture: Texture

Input texture to crop.

Default Value

null

Inherited from

CropTextureProvider.inputTexture


rotation

rotation: number

Angle, in radians, the cropped region is rotated by.

Default Value

0

Methods

ensureLoaded()

ensureLoaded(): Promise<void>

Returns a Promise that resolves once this Provider has finished loading its resource.

Returns

Promise<void>

Remarks

If the Provider is already loaded when ensureLoaded() is called, the returned Promise resolves immediately. Otherwise it resolves once loading completes.

Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.

This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.

Since

Lens Scripting Version 370

Example

Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:

const internetModule = require("LensStudio:InternetModule");
const remoteMediaModule = require("LensStudio:RemoteMediaModule");

function loadImageTexture(url) {
const resource = internetModule.makeResourceFromUrl(url);
return new Promise((resolve, reject) => {
remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
});
}

const texture = await loadImageTexture("https://example.com/image.png");

// Wait until the fetched Texture's Provider has finished loading before using it.
await texture.control.ensureLoaded();
print("Texture ready, loadStatus: " + texture.control.getLoadStatus());

Inherited from

CropTextureProvider.ensureLoaded


getAspect()

getAspect(): number

Returns the texture's aspect ratio, which is calculated as width / height.

Returns

number

Inherited from

CropTextureProvider.getAspect


getHeight()

getHeight(): number

Returns the height of the texture in pixels.

Returns

number

Inherited from

CropTextureProvider.getHeight


getLoadStatus()

getLoadStatus(): LoadStatus

Returns

LoadStatus

Inherited from

CropTextureProvider.getLoadStatus


getTypeName()

static getTypeName(): TypeName<RectCropTextureProvider>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<RectCropTextureProvider>

Overrides

CropTextureProvider.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

CropTextureProvider.getTypeName


getWidth()

getWidth(): number

Returns the width of the texture in pixels.

Returns

number

Inherited from

CropTextureProvider.getWidth


isOfType()

isOfType(type): boolean

Returns true if the object matches or derives from the passed in type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

CropTextureProvider.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

CropTextureProvider.isSame