Difference between revisions of "GLAPI/glBindSampler"

From OpenGL.org
Jump to: navigation, search
m (Bot: Adjusting API page category.)
(Errors: Correcting the constants name: GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS, not GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS)
(5 intermediate revisions by one other user not shown)
Line 9: Line 9:
 
== Function Definition ==
 
== Function Definition ==
  
   void '''glBindSampler'''(GLuint ''unit'', GLuint ''sampler'');
+
   void '''glBindSampler'''(GLuint {{param|unit}}, GLuint {{param|sampler}});
  
 
; unit
 
; unit
Line 18: Line 18:
 
== Description ==
 
== 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 [[GLAPI/glGenSamplers|glGenSamplers]]. ''unit'' must be less than the value of {{code|GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS}}.
+
'''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 ==
  
{{code|GL_INVALID_VALUE}} is generated if ''unit'' is greater than or equal to the value of {{code|GL_MAX_COMBIED_TEXTURE_IMAGE_UNITS}}.
+
{{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}}.
  
{{code|GL_INVALID_OPERATION}} is generated if ''sampler'' is not zero or a name previously returned from a call to [[GLAPI/glGenSamplers|glGenSamplers]], or if such a name has been deleted by a call to [[GLAPI/glDeleteSamplers|glDeleteSamplers]].
+
{{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 ==
  
[[GLAPI/glGet|glGet]] with argument {{code|GL_SAMPLER_BINDING}}
+
{{apifunc|glGet}} with argument {{enum|GL_SAMPLER_BINDING}}
  
 
== See Also ==
 
== See Also ==
  
[[GLAPI/glGenSamplers|glGenSamplers]], [[GLAPI/glDeleteSamplers|glDeleteSamplers]], [[GLAPI/glGet|glGet]], [[GLAPI/glSamplerParameter|glSamplerParameter]], [[GLAPI/glGetSamplerParameter|glGetSamplerParameter]], [[GLAPI/glGenTextures|glGenTextures]], [[GLAPI/glBindTexture|glBindTexture]], [[GLAPI/glDeleteTextures|glDeleteTextures]]
+
{{apifunc|glGenSamplers}}, {{apifunc|glDeleteSamplers}}, {{apifunc|glSamplerParameter}}, {{apifunc|glGetSamplerParameter}}, {{apifunc|glActiveTexture}}, {{apifunc|glBindTexture}}
  
 
== Copyright ==
 
== Copyright ==
Line 44: Line 44:
 
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:API Reference 4|BindSampler]]
+
[[Category:Core API Reference|BindSampler]]
[[Category:GL 4 API Texturing|BindSampler]]
+
[[Category:Core API Ref Texturing|BindSampler]]

Revision as of 16:53, 13 November 2012

glBindSampler
Core in version 4.5
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

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/.