RenderTarget
constRenderTarget:object
Defined in: client/api.d.ts:861
Offscreen surfaces the engine can sample. A render target is a real engine texture, so binding its name with Material.setTexture turns any world material into a live screen: security monitors, scoreboards on a wall, dynamic billboards, vehicle dashboards.
Type Declaration
Section titled “Type Declaration”create()
Section titled “create()”create(
width,height,options?):RenderTargetSurface|null
Creates a render target owned by the calling client resource. Returns null if the size is out of range or the video memory budget is spent.
Parameters
Section titled “Parameters”number
Target width in pixels, at most 2048.
height
Section titled “height”number
Target height in pixels, at most 2048.
options?
Section titled “options?”Returns
Section titled “Returns”RenderTargetSurface | null
destroyAll()
Section titled “destroyAll()”destroyAll():
void
Destroys every render target owned by the calling resource.
Returns
Section titled “Returns”void
getUsage()
Section titled “getUsage()”getUsage():
RenderTargetUsage
Reports how much video memory render targets currently hold.
Returns
Section titled “Returns”isAvailable()
Section titled “isAvailable()”isAvailable():
boolean
Checks whether the texture registry and the renderer are up.
Returns
Section titled “Returns”boolean