GLAPI/glSampleMask

From OpenGL Wiki
< GLAPI
Revision as of 07:02, 26 February 2012 by AlfonsesCategoryBot (talk | contribs) (Renaming category: 'GL 4 API Post Fragment Shader Operations' to 'Core API Ref Post Fragment Shader Operations'.)
Jump to navigation Jump to search
glSampleMaski
Core in version 4.6
Core since version 3.2
Core ARB extension ARB_texture_multisample

glSampleMaski: set the value of a sub-word of the sample mask

Function Definition

 void glSampleMaski(GLuint maskNumber, GLbitfield mask);
maskNumber
Specifies which 32-bit sub-word of the sample mask to update.
mask
Specifies the new value of the mask sub-word.

Description

glSampleMaski sets one 32-bit sub-word of the multi-word sample mask, GL_SAMPLE_MASK_VALUE.

maskIndex specifies which 32-bit sub-word of the sample mask to update, and mask specifies the new value to use for that sub-word. maskIndex must be less than the value of GL_MAX_SAMPLE_MASK_WORDS. Bit B of mask word M corresponds to sample 32 x M + B.

Notes

glSampleMaski is available only if the GL version is 3.2 or greater, or if the ARB_texture_multisample extension is supported.

Errors

GL_INVALID_VALUE is generated if maskIndex is greater than or equal to the value of GL_MAX_SAMPLE_MASK_WORDS.

See Also

glGenRenderbuffers, glBindRenderbuffer, glRenderbufferStorageMultisample, glFramebufferRenderbuffer, glDeleteRenderbuffers

Copyright

Copyright © 2010 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.