类 WebXRRenderTexture

En

The WebXRRenderTexture class is used to create a render texture for WebXR rendering.

Zh

WebXRRenderTexture 类用来创建 WebXR 渲染的渲染纹理。

层级 (查看层级一览)

构造函数

constructor

属性

_id destroyedImmediately frameLoop hdrEncodeFormat lock? name? url uuid DEBUG

访问器

anisoLevel baseMipmapLevel colorFormat compareMode cpuMemory defaultTexture deps depthStencilFormat depthStencilTexture destroyed dimension filterMode format frameBuffer gammaCorrection gammaSpace generateDepthTexture generateMipmap gpuMemory height id isCube maxMipmapLevel mipmap mipmapCount multiSamples obsolute referenceCount samples width wrapModeU wrapModeV wrapModeW bindCanvasRender cpuMemory gpuMemory

方法

_addReference _clearReference _removeReference _setCPUMemory _setCreateURL _setGPUMemory addDep addDeps destroy event getData getDataAsync gpuCompressFormat hasListener isCreateFromURL off offAll offAllCaller on once recreate clearPool createFromPool destroyUnusedResources recoverToPool

构造函数

constructor

属性

_id

_id: number = 0

destroyedImmediately

destroyedImmediately: boolean

En

Whether to delete the resource immediately when the reference count is 0.

Zh

是否在引用计数为0的时候立马删除他

frameLoop

frameLoop: number = -1

En

The frame loop counter for the render texture.

Zh

渲染纹理的帧循环计数器。

hdrEncodeFormat

hdrEncodeFormat: HDREncodeFormat

En

hdr encode format

Zh

hdr编码格式

可选lock

lock?: boolean

En

Whether to lock the resource, if true, the resource cannot be automatically released.

Zh

是否加锁，如果true为不能使用自动释放机制。

可选name

name?: string

En

The name of the resource.

Zh

资源名称。

url

url: string

En

The URL of the resource.

Zh

获取资源的URL地址。

uuid

uuid: string

En

The UUID of the resource.

Zh

获取资源的UUID。

静态DEBUG

DEBUG: boolean = false

En

Whether the debug mode is enabled.

Zh

是否开启调试模式。

访问器

anisoLevel

baseMipmapLevel

colorFormat

compareMode

cpuMemory

defaultTexture

deps

depthStencilFormat

depthStencilTexture

destroyed

dimension

filterMode

format

frameBuffer

gammaCorrection

  • get gammaCorrection(): number

    返回 number

    En

    The gamma correction value of the texture. If set to 1.0, texture sampling will be linear without any correction.

    Zh

    纹理的伽马校正值。如果设置为1.0，则纹理采样将为线性，不进行任何校正。

gammaSpace

generateDepthTexture

generateMipmap

gpuMemory

height

id

isCube

maxMipmapLevel

mipmap

mipmapCount

  • get mipmapCount(): number

    返回 number

    En

    The number of mipmap generated for this texture.

    Zh

    为此纹理生成的mipmap数量。

multiSamples

obsolute

  • get obsolute(): boolean

    返回 boolean

    En

    If a cached resource observer is set to true, then:

      1. getRes will still return this resource;
      1. next time loading will ignore this cached resource and reload it.

    Zh

    如果设置一个已缓存的资源obsolute为true，则

    • 1）getRes仍然可以返回这个资源；
    • 2）下次加载时会忽略这个缓存而去重新加载。。
  • set obsolute(value: boolean): void

    参数

    • value: boolean

    返回 void

referenceCount

samples

width

wrapModeU

wrapModeV

wrapModeW

静态bindCanvasRender

静态cpuMemory

静态gpuMemory

方法

_addReference

  • _addReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to increment the reference count, default is 1.

    返回 void

    En

    Increments the reference count of the resource by the specified amount.

    Zh

    按指定数量增加资源的引用计数。

_clearReference

_removeReference

  • _removeReference(count?: number): void

    参数

    • count: number = 1

      The amount by which to decrement the reference count, default is 1.

    返回 void

    En

    Decrements the reference count of the resource by the specified amount. If the reference count reaches zero and certain conditions are met, the resource may be destroyed.

    Zh

    按指定数量减少资源的引用计数。如果引用计数达到零并且满足特定条件，资源可能会被销毁。

_setCPUMemory

_setCreateURL

  • _setCreateURL(url: string, uuid?: string): void

    参数

    • url: string

      The URL used to create the resource.

    • 可选uuid: string

      The optional UUID of the resource.

    返回 void

    En

    Sets the URL and UUID used to create this resource.

    Zh

    设置用于创建此资源的 URL 和 UUID。

_setGPUMemory

addDep

addDeps

destroy

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

getData

  • getData(
        xOffset: number,
        yOffset: number,
        width: number,
        height: number,
        out: Float32Array | Uint8Array,
    ): Float32Array | Uint8Array

    参数

    • xOffset: number

      x偏移值

    • yOffset: number

      y偏移值

    • width: number

      宽度

    • height: number

      高度

    • out: Float32Array | Uint8Array

      输出

    返回 Float32Array | Uint8Array

    二进制数据

    已被弃用

    请使用getDataAsync函数代替 获取渲染纹理的像素数据

getDataAsync

  • getDataAsync(
        xOffset: number,
        yOffset: number,
        width: number,
        height: number,
        out: Float32Array | Uint8Array,
    ): Promise<ArrayBufferView>

    参数

    • xOffset: number

      The x-offset value.

    • yOffset: number

      The y-offset value.

    • width: number

      The width of the area to retrieve.

    • height: number

      The height of the area to retrieve.

    • out: Float32Array | Uint8Array

      The array to hold the output data.

    返回 Promise<ArrayBufferView>

    binary data

    En

    Asynchronously retrieves pixel data from the RenderTexture.

    Zh

    异步获取渲染纹理的像素数据。

gpuCompressFormat

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

isCreateFromURL

  • isCreateFromURL(url: string): boolean

    参数

    • url: string

      The URL to check against the resource's creation URL.

    返回 boolean

    True if the resource is created from the specified URL, otherwise false.

    En

    Checks if the resource is created from the specified URL.

    Zh

    检查资源是否从指定的 URL 创建。

off

offAll

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

recreate

  • recreate(
        width: number,
        height: number,
        colorFormat: RenderTargetFormat,
        depthFormat: RenderTargetFormat,
        generateMipmap?: boolean,
        multiSamples?: number,
        generateDepthTexture?: boolean,
        sRGB?: boolean,
    ): void

    参数

    • width: number

      New width of the RenderTexture.

    • height: number

      New height of the RenderTexture.

    • colorFormat: RenderTargetFormat

      New color format for the RenderTexture.

    • depthFormat: RenderTargetFormat

      New depth format for the RenderTexture.

    • generateMipmap: boolean = false

      Whether to regenerate mipmaps for the RenderTexture.

    • multiSamples: number = 1

      New number of multisamples for the RenderTexture.

    • generateDepthTexture: boolean = false

      Whether to generate a new depth texture for the RenderTexture.

    • sRGB: boolean = false

      Whether the RenderTexture uses sRGB color space.

    返回 void

    En

    Recreates the RenderTexture with the specified parameters.

    Zh

    使用指定参数重新创建RenderTexture。

静态clearPool

静态createFromPool

  • createFromPool(
        width: number,
        height: number,
        colorFormat: RenderTargetFormat,
        depthFormat: RenderTargetFormat,
        mipmap?: boolean,
        multiSamples?: number,
        depthTexture?: boolean,
        sRGB?: boolean,
    ): RenderTexture

    参数

    • width: number

      Width of the RenderTexture.

    • height: number

      Height of the RenderTexture.

    • colorFormat: RenderTargetFormat

      Color format of the RenderTexture.

    • depthFormat: RenderTargetFormat

      Depth format of the RenderTexture.

    • mipmap: boolean = false

      Whether to generate mipmaps for the RenderTexture.

    • multiSamples: number = 1

      Number of multisamples for the RenderTexture.

    • depthTexture: boolean = false

      Whether to generate a depth texture.

    • sRGB: boolean = false

      Whether the RenderTexture is in sRGB space.

    返回 RenderTexture

    A RenderTexture instance.

    En

    Creates a RenderTexture instance from the pool.

    Zh

    从对象池中创建一个RenderTexture实例。

静态destroyUnusedResources

静态recoverToPool

显示设置

成员可见性

目录

构造函数
属性
访问器
方法