WebGLRenderingContext: getFramebufferAttachmentParameter() 方法
注意:此功能在 Web Workers 中可用。
WebGLRenderingContext.getFramebufferAttachmentParameter() 方法是 WebGL API 的一部分,用于返回关于帧缓冲附件的信息。
语法
js
getFramebufferAttachmentParameter(target, attachment, pname)
参数
目标-
一个
GLenum,指定绑定点(目标)。可能的值gl.FRAMEBUFFER-
用于渲染图像的颜色、Alpha、深度和模板缓冲区的集合缓冲区数据存储。
使用 WebGL 2 上下文时,还可以使用以下值:
gl.DRAW_FRAMEBUFFER-
相当于
gl.FRAMEBUFFER。用作绘图、渲染、清除和写入操作的目标。 gl.READ_FRAMEBUFFER-
用作读取操作的源。
attachment-
一个
GLenum,指定texture的附件点。可能的值gl.COLOR_ATTACHMENT0:帧缓冲颜色缓冲区的纹理附件。gl.DEPTH_ATTACHMENT:帧缓冲深度缓冲区的纹理附件。gl.STENCIL_ATTACHMENT:帧缓冲模板缓冲区的纹理附件。gl.DEPTH_STENCIL_ATTACHMENT:深度和模板缓冲区的纹理附件。
使用 WebGL 2 上下文时,还可以使用以下值:
gl.COLOR_ATTACHMENT1 gl.COLOR_ATTACHMENT2 gl.COLOR_ATTACHMENT3 gl.COLOR_ATTACHMENT4 gl.COLOR_ATTACHMENT5 gl.COLOR_ATTACHMENT6 gl.COLOR_ATTACHMENT7 gl.COLOR_ATTACHMENT8 gl.COLOR_ATTACHMENT9 gl.COLOR_ATTACHMENT10 gl.COLOR_ATTACHMENT11 gl.COLOR_ATTACHMENT12 gl.COLOR_ATTACHMENT13 gl.COLOR_ATTACHMENT14 gl.COLOR_ATTACHMENT15
使用
WEBGL_draw_buffers扩展时ext.COLOR_ATTACHMENT0_WEBGL(与gl.COLOR_ATTACHMENT0相同)ext.COLOR_ATTACHMENT1_WEBGL ext.COLOR_ATTACHMENT2_WEBGL ext.COLOR_ATTACHMENT3_WEBGL ext.COLOR_ATTACHMENT4_WEBGL ext.COLOR_ATTACHMENT5_WEBGL ext.COLOR_ATTACHMENT6_WEBGL ext.COLOR_ATTACHMENT7_WEBGL ext.COLOR_ATTACHMENT8_WEBGL ext.COLOR_ATTACHMENT9_WEBGL ext.COLOR_ATTACHMENT10_WEBGL ext.COLOR_ATTACHMENT11_WEBGL ext.COLOR_ATTACHMENT12_WEBGL ext.COLOR_ATTACHMENT13_WEBGL ext.COLOR_ATTACHMENT14_WEBGL ext.COLOR_ATTACHMENT15_WEBGL
pname-
一个
GLenum,指定要查询的信息。可能的值gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE:包含已附加图像的类型。gl.FRAMEBUFFER_ATTACHMENT_OBJECT_NAME:已附加图像的纹理或渲染缓冲区(WebGLRenderbuffer或WebGLTexture)。gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL:Mipmap 级别。默认值:0。gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE:纹理的立方体贴图面的名称。
使用
EXT_sRGB扩展时ext.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING_EXT:帧缓冲颜色编码。
使用 WebGL 2 上下文时,还可以使用以下值:
gl.FRAMEBUFFER_ATTACHMENT_ALPHA_SIZEgl.FRAMEBUFFER_ATTACHMENT_BLUE_SIZEgl.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODINGgl.FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPEgl.FRAMEBUFFER_ATTACHMENT_DEPTH_SIZEgl.FRAMEBUFFER_ATTACHMENT_GREEN_SIZEgl.FRAMEBUFFER_ATTACHMENT_RED_SIZEgl.FRAMEBUFFER_ATTACHMENT_STENCIL_SIZEgl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER
使用
OVR_multiview2扩展时ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_NUM_VIEWS_OVR:帧缓冲对象附件的视图数量。ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_BASE_VIEW_INDEX_OVR:帧缓冲对象附件的基础视图索引。
返回值
取决于请求的信息(由 pname 指定)。可以是 GLint、GLenum、WebGLRenderbuffer 或 WebGLTexture。
pname 参数 |
返回值 |
|---|---|
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE |
一个 GLenum,指示纹理的类型。可以是 gl.RENDERBUFFER、gl.TEXTURE,或者如果没有附加图像,则为 gl.NONE。 |
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_NAME |
已附加图像的纹理(WebGLTexture)或渲染缓冲区(WebGLRenderbuffer)。 |
gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL |
一个 GLint,指示 mipmap 级别。默认值:0。 |
gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE |
一个 GLenum,指示纹理的立方体贴图面名称。可能的值
|
gl.FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE |
一个 GLint,指示附件 Alpha 组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_BLUE_SIZE |
一个 GLint,指示附件蓝色组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING |
一个 GLenum,指示指定附件组件的编码。可以是 gl.LINEAR 或 gl.SRGB。 |
gl.FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE |
一个 GLenum,指示指定附件组件的格式。可以是 gl.FLOAT、gl.INT、gl.UNSIGNED_INT、gl.SIGNED_NORMALIZED 或 gl.UNSIGNED_NORMALIZED。 |
gl.FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE |
一个 GLint,指示附件深度组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_GREEN_SIZE |
一个 GLint,指示附件绿色组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_RED_SIZE |
一个 GLint,指示附件红色组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE |
一个 GLint,指示附件模板组件的位数。 |
gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER |
一个 GLint,指示包含已附加图像的纹理层的数量。 |
ext.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING_EXT |
一个 GLenum,指示帧缓冲颜色编码。可以是 gl.LINEAR 或 ext.SRGB_EXT。 |
ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_NUM_VIEWS_OVR |
一个 GLsizei,指示帧缓冲对象附件的视图数量。 |
ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_BASE_VIEW_INDEX_OVR
|
一个 GLint,指示帧缓冲对象附件的基础视图索引。 |
异常
- 如果
target不是gl.FRAMEBUFFER、gl.DRAW_FRAMEBUFFER、gl.READ_FRAMEBUFFER,或者attachment不是接受的附件点之一,则会抛出gl.INVALID_ENUM错误。
示例
js
gl.getFramebufferAttachmentParameter(
gl.FRAMEBUFFER,
gl.COLOR_ATTACHMENT0,
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE,
);
规范
| 规范 |
|---|
| WebGL 规范 # 5.14.6 |
| WebGL 2.0 规范 # 3.7.4 |
浏览器兼容性
加载中…