GLAPI/glGetFragDataLocation: Difference between revisions

From OpenGL Wiki
Jump to navigation Jump to search
m Renaming category: 'API Reference 4' to 'Core API Reference'.
m Bot: Adding better formatting.
 
(5 intermediate revisions by 2 users not shown)
Line 8: Line 8:
== Function Definition ==
== Function Definition ==


   GLint '''glGetFragDataLocation'''(GLuint ''program'', const char * ''name'');
   GLint '''glGetFragDataLocation'''(GLuint {{param|program}}, const char * {{param|name}});


; program
; program
Line 17: Line 17:
== Description ==
== Description ==


'''glGetFragDataLocation''' retrieves the assigned color number binding for the user-defined varying out variable ''name'' for program ''program''. ''program'' must have previously been linked. ''name'' must be a null-terminated string. If ''name'' is not the name of an active user-defined varying out fragment shader variable within ''program'', -1 will be returned.
'''glGetFragDataLocation''' retrieves the assigned color number binding for the user-defined varying out variable {{param|name}} for program {{param|program}}. {{param|program}} must have previously been linked. {{param|name}} must be a null-terminated string. If {{param|name}} is not the name of an active user-defined varying out fragment shader variable within {{param|program}}, -1 will be returned.


== Errors ==
== Errors ==


{{code|GL_INVALID_OPERATION}} is generated if ''program'' is not the name of a program object.
{{enum|GL_INVALID_OPERATION}} is generated if {{param|program}} is not the name of a program object.


== See Also ==
== See Also ==


[[GLAPI/glCreateProgram|glCreateProgram]], [[GLAPI/glBindFragDataLocation|glBindFragDataLocation]]
{{apifunc|glLinkProgram}}, {{apifunc|glBindFragDataLocation}}, {{apifunc|glBindFragDataLocationIndexed}}, {{apifunc|glGetFragDataIndex}}, {{apifunc|glGetProgramResource}}, {{apifunc|glGetProgramResourceLocation}}


== Copyright ==
== Copyright ==
Line 31: Line 31:
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:GL 4 API Shader Program Creation|GetFragDataLocation]]
[[Category:Core API Reference|GetFragDataLocation]]
[[Category:Core API Reference|GetFragDataLocation]]
[[Category:Core API Ref Shader Program Query|GetFragDataLocation]]
[[Category:Program Object API State Functions|GetFragDataLocation]]

Latest revision as of 09:59, 15 August 2013

glGetFragDataLocation
Core in version 4.6
Core since version 3.0

glGetFragDataLocation: query the bindings of color numbers to user-defined varying out variables

Function Definition

 GLint glGetFragDataLocation(GLuint program​, const char * name​);
program
The name of the program containing varying out variable whose binding to query
name
The name of the user-defined varying out variable whose binding to query

Description

glGetFragDataLocation retrieves the assigned color number binding for the user-defined varying out variable name​ for program program​. program​ must have previously been linked. name​ must be a null-terminated string. If name​ is not the name of an active user-defined varying out fragment shader variable within program​, -1 will be returned.

Errors

GL_INVALID_OPERATION is generated if program​ is not the name of a program object.

See Also

glLinkProgram, glBindFragDataLocation, glBindFragDataLocationIndexed, glGetFragDataIndex, glGetProgramResource, glGetProgramResourceLocation

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