95 lines
4.1 KiB
XML
95 lines
4.1 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
|
<refentry id="glCompileShader">
|
|
<refentryinfo>
|
|
<copyright>
|
|
<year>2003-2005</year>
|
|
<holder>3Dlabs Inc. Ltd.</holder>
|
|
</copyright>
|
|
<copyright>
|
|
<year>2010-2013</year>
|
|
<holder>Khronos Group</holder>
|
|
</copyright>
|
|
</refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>glCompileShader</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glCompileShader</refname>
|
|
<refpurpose>Compiles a shader object</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glCompileShader</function></funcdef>
|
|
<paramdef>GLuint <parameter>shader</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>shader</parameter></term>
|
|
<listitem>
|
|
<para>Specifies the shader object to be
|
|
compiled.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para><function>glCompileShader</function> compiles the source
|
|
code strings that have been stored in the shader object
|
|
specified by <parameter>shader</parameter>.</para>
|
|
|
|
<para>The compilation status will be stored as part of the
|
|
shader object's state. This value will be set to
|
|
<constant>GL_TRUE</constant> if the shader was compiled without
|
|
errors and is ready for use, and <constant>GL_FALSE</constant>
|
|
otherwise. It can be queried by calling
|
|
<citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
|
|
with arguments <parameter>shader</parameter> and
|
|
<constant>GL_COMPILE_STATUS</constant>.</para>
|
|
|
|
<para>Compilation of a shader can fail for a number of reasons
|
|
as specified by the OpenGL Shading Language Specification.
|
|
Whether or not the compilation was successful, information about
|
|
the compilation can be obtained from the shader object's
|
|
information log by calling
|
|
<citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>.</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para><constant>GL_INVALID_VALUE</constant> is generated if
|
|
<parameter>shader</parameter> is not a value generated by
|
|
OpenGL.</para>
|
|
|
|
<para><constant>GL_INVALID_OPERATION</constant> is generated if
|
|
<parameter>shader</parameter> is not a shader object.</para>
|
|
|
|
</refsect1>
|
|
<refsect1 id="associatedgets"><title>Associated Gets</title>
|
|
<para><citerefentry><refentrytitle>glGetShaderInfoLog</refentrytitle></citerefentry>
|
|
with argument <parameter>shader</parameter></para>
|
|
|
|
<para><citerefentry><refentrytitle>glGetShader</refentrytitle></citerefentry>
|
|
with arguments <parameter>shader</parameter> and
|
|
<constant>GL_COMPILE_STATUS</constant></para>
|
|
<para><citerefentry><refentrytitle>glIsShader</refentrytitle></citerefentry></para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para><citerefentry><refentrytitle>glCreateShader</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glLinkProgram</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glShaderSource</refentrytitle></citerefentry></para>
|
|
</refsect1>
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
|
<para>
|
|
Copyright <trademark class="copyright"></trademark> 2003-2005 3Dlabs Inc. Ltd.
|
|
Copyright <trademark class="copyright"></trademark> 2010-2013 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.
|
|
<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|