GLAPI/glBindSampler: Difference between revisions
m Renaming category: 'API Reference 4' to 'Core API Reference'. |
m Bot: Adding better formatting. |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 9: | Line 9: | ||
== Function Definition == | == Function Definition == | ||
void '''glBindSampler'''(GLuint | void '''glBindSampler'''(GLuint {{param|unit}}, GLuint {{param|sampler}}); | ||
; unit | ; unit | ||
| Line 18: | Line 18: | ||
== Description == | == Description == | ||
'''glBindSampler''' binds | '''glBindSampler''' binds {{param|sampler}} to the texture unit at index {{param|unit}}. {{param|sampler}} must be zero or the name of a sampler object previously returned from a call to {{apifunc|glGenSamplers}}. {{param|unit}} must be less than the value of {{enum|GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS}}. | ||
When a sampler object is bound to a texture unit, its state supersedes that of the texture object bound to that texture unit. If the sampler name zero is bound to a texture unit, the currently bound texture's sampler state becomes active. A single sampler object may be bound to multiple texture units simultaneously. | When a sampler object is bound to a texture unit, its state supersedes that of the texture object bound to that texture unit. If the sampler name zero is bound to a texture unit, the currently bound texture's sampler state becomes active. A single sampler object may be bound to multiple texture units simultaneously. | ||
| Line 28: | Line 28: | ||
== Errors == | == Errors == | ||
{{ | {{enum|GL_INVALID_VALUE}} is generated if {{param|unit}} is greater than or equal to the value of {{enum|GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS}}. | ||
{{ | {{enum|GL_INVALID_OPERATION}} is generated if {{param|sampler}} is not zero or a name previously returned from a call to {{apifunc|glGenSamplers}}, or if such a name has been deleted by a call to {{apifunc|glDeleteSamplers}}. | ||
== Associated Gets == | == Associated Gets == | ||
{{apifunc|glGet}} with argument {{enum|GL_SAMPLER_BINDING}} | |||
== See Also == | == See Also == | ||
{{apifunc|glBindSamplers}}, {{apifunc|glGenSamplers}}, {{apifunc|glDeleteSamplers}}, {{apifunc|glSamplerParameter}}, {{apifunc|glGetSamplerParameter}}, {{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}} | |||
* [[Sampler Object]] | |||
== Copyright == | == Copyright == | ||
| Line 44: | Line 46: | ||
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/ http://opencontent.org/openpub/]. | 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/ http://opencontent.org/openpub/]. | ||
[[Category:Core API Reference|BindSampler]] | [[Category:Core API Reference|BindSampler]] | ||
[[Category:Core API Ref Texturing|BindSampler]] | |||
Latest revision as of 01:38, 25 July 2013
| Core in version | 4.6 | |
|---|---|---|
| Core since version | 3.3 | |
| Core ARB extension | ARB_sampler_objects | |
glBindSampler: bind a named sampler to a texturing target
Function Definition
void glBindSampler(GLuint unit, GLuint sampler);
- unit
- Specifies the index of the texture unit to which the sampler is bound.
- sampler
- Specifies the name of a sampler.
Description
glBindSampler binds sampler to the texture unit at index unit. sampler must be zero or the name of a sampler object previously returned from a call to glGenSamplers. unit must be less than the value of GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS.
When a sampler object is bound to a texture unit, its state supersedes that of the texture object bound to that texture unit. If the sampler name zero is bound to a texture unit, the currently bound texture's sampler state becomes active. A single sampler object may be bound to multiple texture units simultaneously.
Notes
glBindSampler is available only if the GL version is 3.3 or higher.
Errors
GL_INVALID_VALUE is generated if unit is greater than or equal to the value of GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS.
GL_INVALID_OPERATION is generated if sampler is not zero or a name previously returned from a call to glGenSamplers, or if such a name has been deleted by a call to glDeleteSamplers.
Associated Gets
glGet with argument GL_SAMPLER_BINDING
See Also
glBindSamplers, glGenSamplers, glDeleteSamplers, glSamplerParameter, glGetSamplerParameter, glActiveTexture, glBindTexture
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/.