WebGLRenderingContext: getFramebufferAttachmentParameter() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Note: This feature is available in Web Workers.
Phương thức WebGLRenderingContext.getFramebufferAttachmentParameter() của WebGL API trả về thông tin về phần đính kèm của bộ đệm khung.
Cú pháp
getFramebufferAttachmentParameter(target, attachment, pname)
Thông số
target-
A
GLenumchỉ định điểm liên kết (đích). Các giá trị có thể:gl.FRAMEBUFFER-
Bộ sưu tập bộ đệm lưu trữ dữ liệu màu, alpha, bộ đệm độ sâu và stencil được sử dụng để hiển thị hình ảnh.
Khi sử dụng WebGL 2 context, các giá trị sau đây có sẵn bổ sung:
- gl.DRAW_FRAMEBUFFER
- : Tương đương với gl.FRAMEBUFFER.
Được sử dụng làm đích cho các hoạt động vẽ, hiển thị, xóa và viết.
- gl.READ_FRAMEBUFFER
- : Được sử dụng làm nguồn cho các hoạt động đọc.
attachment-
A
GLenumchỉ định điểm đính kèm chotexture. Các giá trị có thể:gl.COLOR_ATTACHMENT0: Đính kèm họa tiết cho bộ đệm khung đệm màu.gl.DEPTH_ATTACHMENT: Đính kèm họa tiết cho độ sâu của bộ đệm khung bộ đệm.gl.STENCIL_ATTACHMENT: Đính kèm họa tiết cho bộ đệm khung bộ đệm stencil.gl.DEPTH_STENCIL_ATTACHMENT: Đính kèm họa tiết cho cả hai, độ sâu và bộ đệm stencil.
Khi sử dụng WebGL 2 context, các giá trị sau đây có sẵn bổ sung:
- 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
Khi sử dụng phần mở rộng WEBGL_draw_buffers:
- ext.COLOR_ATTACHMENT0_WEBGL (giống như
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-
Một
GLenumchỉ định thông tin cần truy vấn. Các giá trị có thể:gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE: Loại chứa hình ảnh đính kèm.gl.FRAMEBUFFER_ATTACHMENT_OBJECT_NAME: Kết cấu hoặc bộ đệm kết xuất của ảnh đính kèm (WebGLRenderbufferhoặcWebGLTexture).gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL: Cấp độ Mipmap. Mặc định giá trị: 0.gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE: Tên của mặt bản đồ khối của kết cấu.
Khi sử dụng phần mở rộng EXT_sRGB:
- ext.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING_EXT: Bộ đệm khung
mã hóa màu sắc.
Khi sử dụng WebGL 2 context, các giá trị sau đây có sẵn bổ sung:
- gl.FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_BLUE_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING
- gl.FRAMEBUFFER_ATTACHMENT_COMPONENT_TYPE
- gl.FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_GREEN_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_RED_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE
- gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LAYER
Khi sử dụng phần mở rộng OVR_multiview2:
- ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_NUM_VIEWS_OVR: số lượt xem của tệp đính kèm đối tượng bộ đệm khung.
- ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_BASE_VIEW_INDEX_OVR: chỉ số khung nhìn cơ sở của phần đính kèm đối tượng bộ đệm khung.
Giá trị trả về
Phụ thuộc vào thông tin được yêu cầu (như được chỉ định với pname). Hoặc là GLint, GLenum, WebGLRenderbuffer, hoặc WebGLTexture.
pname tham số | Giá trị trả về |
|---|---|
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE | A GLenum biểu thị loại của kết cấu. Hoặc gl.RENDERBUFFER, gl.TEXTURE, hoặc nếu không có hình ảnh nào được đính kèm, gl.NONE. |
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_NAME | Kết cấu (TOK1��) hoặc bộ đệm kết xuất (WebGLRenderbuffer) của ảnh đính kèm. |
gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_LEVEL | A GLint cho biết mức độ mipmap. Giá trị mặc định: 0. |
gl.FRAMEBUFFER_ATTACHMENT_TEXTURE_CUBE_MAP_FACE | Một GLenum cho biết tên của mặt bản đồ khối của kết cấu. Các giá trị có thể có:
|
gl.FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE | A GLint cho biết số bit trong thành phần alpha của phần đính kèm. |
gl.FRAMEBUFFER_ATTACHMENT_BLUE_SIZE | GLint cho biết số bit trong thành phần màu xanh của phần đính kèm. A GLenum biểu thị mã hóa của các thành phần của tệp đính kèm được chỉ định. Hoặc gl.LINEART hoặc gl.SRGB. A GLenum cho biết định dạng của các thành phần của tệp đính kèm được chỉ định. Hoặc gl.FLOAT, gl.INT, gl.UNSIGNED_INT, gl.SIGNED_NORMALIZED, hoặc gl.UNSIGNED_NORMALIZED. A GLint cho biết số bit trong thành phần độ sâu của phần đính kèm. |
gl.FRAMEBUFFER_ATTACHMENT_GREEN_SIZE | GLint cho biết số bit trong thành phần màu xanh lá cây của phần đính kèm. A GLint cho biết số bit trong thành phần màu đỏ của phần đính kèm. �TOK161� GLint cho biết số bit trong thành phần stencil của phần đính kèm. A GLint cho biết số lớp kết cấu chứa hình ảnh đính kèm. |
ext.FRAMEBUFFER_ATTACHMENT_COLOR_ENCODING_EXT | Một GLenum biểu thị mã hóa màu của bộ đệm khung. Hoặc gl.LINEART hoặc ext.SRGB_EXT. |
ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_NUM_VIEWS_OVR | Một GLsizei cho biết số lượt xem của tệp đính kèm đối tượng bộ đệm khung. |
ext.FRAMEBUFFER_ATTACHMENT_TEXTURE_BASE_VIEW_INDEX_OVR | Một GLint biểu thị chỉ số khung nhìn cơ sở của đối tượng đính kèm bộ đệm khung. |
Ngoại lệ
- Một lỗi
gl.INVALID_ENUMsẽ xuất hiện nếutargetkhông đượcgl.FRAMEBUFFER,gl.DRAW_FRAMEBUFFER,gl.READ_FRAMEBUFFERhoặc nếuattachmentkhông phải là một trong những điểm đính kèm được chấp nhận.
Ví dụ
gl.getFramebufferAttachmentParameter(
gl.FRAMEBUFFER,
gl.COLOR_ATTACHMENT0,
gl.FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE,
);
Thông số kỹ thuật
| Specification |
|---|
| WebGL Specification> # 5.14.6> |
| WebGL 2.0 Specification> # 3.7.4> |