Return to glGenTextures.xml CVS log

Up to [Development] / projects / ogl-sample / main / doc / gles / xml

OpenGL ES 1.0 and EGL 1.0 reference manual and man pages (written by
Claude Knaus, based on OpenGL SI man pages).

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.2//EN" "DTD/docbook/docbookx.dtd">

<!--
  License Applicability. Except to the extent portions of this file are
  made subject to an alternative license as permitted in the SGI Free
  Software License B, Version 1.1 (the "License"), the contents of this
  file are subject only to the provisions of the License. You may not use
  this file except in compliance with the License. You may obtain a copy
  of the License at Silicon Graphics, Inc., attn: Legal Services, 1600
  Amphitheatre Parkway, Mountain View, CA 94043-1351, or at:

  http://oss.sgi.com/projects/FreeB

  Note that, as provided in the License, the Software is distributed on an
  "AS IS" basis, with ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS
  DISCLAIMED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES AND
  CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A
  PARTICULAR PURPOSE, AND NON-INFRINGEMENT.

  Original Code. The Original Code is: OpenGL ES Reference Manual,
  Version 1.0, released September 2003, developed by Silicon Graphics,
  Inc.  The Original Code is Copyright (c) 2003 Silicon Graphics, Inc.
  Copyright in any portions created by third parties is as indicated
  elsewhere herein.  All Rights Reserved.
-->

<refentry id="glGenTextures">
  <refmeta>
    <refentrytitle>glGenTextures</refentrytitle>
    <manvolnum>3G</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>glGenTextures</refname>
    <refpurpose>generate texture names</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>C Specification</title>

    <funcsynopsis>
      <funcprototype>
        <funcdef>void <function>glGenTextures</function></funcdef>
        <paramdef>GLsizei <parameter>n</parameter></paramdef>
        <paramdef>GLuint * <parameter>textures</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term>
          <parameter>n</parameter>
        </term>

        <listitem>
          <para>Specifies the number of texture names to be generated.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <parameter>textures</parameter>
        </term>

        <listitem>
          <para>Specifies an array in which the generated texture
          names are stored.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><function>glGenTextures</function> returns 
    <parameter>n</parameter> texture names in 
    <parameter>textures</parameter>.
    There is no guarantee that the names form a contiguous set of
    integers. However, it is guaranteed that none of the returned
    names was in use immediately before the call to 
    <function>glGenTextures</function>.</para>

    <para>The generated textures have no dimensionality; they
    assume the dimensionality of the texture target to which they
    are first bound (see 
    <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>).</para>

    <para>Texture names returned by a call to 
    <function>glGenTextures</function>
    are not returned by subsequent calls, unless they are first deleted with 
    <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>.</para>
  </refsect1>

  <refsect1>
    <title>Errors</title>

    <para><constant>GL_INVALID_VALUE</constant> is generated if 
    <parameter>n</parameter> is negative.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>

    <para>
    <citerefentry><refentrytitle>glBindTexture</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glDeleteTextures</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, 
    <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
    </para>
  </refsect1>
</refentry>