Return to glFlush.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="glFlush">
  <refmeta>
    <refentrytitle>glFlush</refentrytitle>
    <manvolnum>3G</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>glFlush</refname>
    <refpurpose>force execution of GL commands in finite time</refpurpose>
  </refnamediv>

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

    <funcsynopsis>
      <funcprototype>
        <funcdef>void <function>glFlush</function></funcdef>
        <void/>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>Different GL implementations buffer commands in several
    different locations, including network buffers and the graphics
    accelerator itself.  <function>glFlush</function>
    empties all of these buffers, causing all issued commands to be
    executed as quickly as they are accepted by the actual
    rendering engine. Though this execution may not be completed in
    any particular time period, it does complete in finite
    time.</para>

    <para>Because any GL program might be executed over a network,
    or on an accelerator that buffers commands, all programs should
    call <function>glFlush</function>
    whenever they count on having all of their previously issued
    commands completed. For example, call <function>glFlush</function>
    before waiting for user input that depends on the generated
    image.</para>
  </refsect1>

  <refsect1>
    <title>Notes</title>

    <para>
      <function>glFlush</function>
      can return at any time. It does not wait until the execution of
      all previously issued GL commands is complete.
    </para>
  </refsect1>

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

    <para>
      <citerefentry><refentrytitle>glFinish</refentrytitle></citerefentry>
    </para>
  </refsect1>
</refentry>