IABSD.fr/xenocara/doc/gl-docs/GL/gl/rendermode.3gl

Branch : - branch - master - tag -

• Show log

  Commit

• Author : matthieu
  Date : 2006-11-29 17:00:35
  Hash : 36da9a5e
  Message : OpenGL manual pages from monolithic tree.

• doc/gl-docs/GL/gl/rendermode.3gl

• '\" e
  '\"! eqn | mmdoc
  '\"macro stdmacro
  .ds Vn Version 1.2
  .ds Dt 24 September 1999
  .ds Re Release 1.2.1
  .ds Dp Jan 14 18:30
  .ds Dm 01 rendermod
  .ds Xs 54049 5 rendermode.gl
  .TH GLRENDERMODE 3G
  .SH NAME
  .B "glRenderMode
  \- set rasterization mode
  
  .SH C SPECIFICATION
  GLint \f3glRenderMode\fP(
  GLenum \fImode\fP )
  .nf
  .fi
  
  .SH PARAMETERS
  .TP \w'\f2mode\fP\ \ 'u 
  \f2mode\fP
  Specifies the rasterization mode.
  Three values are accepted:
  \%\f3GL_RENDER\fP,
  \%\f3GL_SELECT\fP, and
  \%\f3GL_FEEDBACK\fP.
  The initial value is \%\f3GL_RENDER\fP.
  .SH DESCRIPTION
  \%\f3glRenderMode\fP sets the rasterization mode.
  It takes one argument,
  \f2mode\fP,
  which can assume one of three predefined values: 
  .TP 16
  \%\f3GL_RENDER\fP
  Render mode. Primitives are rasterized,
  producing pixel fragments,
  which are written into the frame buffer.
  This is the normal mode
  and also the default mode.
  .TP
  \%\f3GL_SELECT\fP 
  Selection mode.
  No pixel fragments are produced,
  and no change to the frame buffer contents is made.
  Instead,
  a record of the names of primitives that would have been drawn
  if the render mode had been \%\f3GL_RENDER\fP is returned in a select buffer,
  which must be created (see \%\f3glSelectBuffer\fP) before selection mode 
  is entered.
  .TP
  \%\f3GL_FEEDBACK\fP
  Feedback mode.
  No pixel fragments are produced,
  and no change to the frame buffer contents is made.
  Instead,
  the coordinates and attributes of vertices that would have been drawn
  if the render mode had been \%\f3GL_RENDER\fP is returned in a feedback buffer,
  which must be created (see \%\f3glFeedbackBuffer\fP) before feedback mode
  is entered.
  .P
  The return value of \%\f3glRenderMode\fP is determined by the render mode at the time
  \%\f3glRenderMode\fP is called,
  rather than by \f2mode\fP.
  The values returned for the three render modes are as follows:
  .TP 16
  \%\f3GL_RENDER\fP
  0.
  .TP
  \%\f3GL_SELECT\fP
  The number of hit records transferred to the select buffer.
  .TP
  \%\f3GL_FEEDBACK\fP
  The number of values (not vertices) transferred to the feedback buffer.
  .P
  See the \%\f3glSelectBuffer\fP and \%\f3glFeedbackBuffer\fP reference pages for
  more details concerning selection and feedback operation.
  .SH NOTES
  If an error is generated,
  \%\f3glRenderMode\fP returns 0 regardless of the current render mode.
  .SH ERRORS
  \%\f3GL_INVALID_ENUM\fP is generated if \f2mode\fP is not one of the three
  accepted values.
  .P
  \%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glSelectBuffer\fP is called
  while the render mode is \%\f3GL_SELECT\fP,
  or if \%\f3glRenderMode\fP is called with argument \%\f3GL_SELECT\fP before
  \%\f3glSelectBuffer\fP is called at least once.
  .P
  \%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glFeedbackBuffer\fP is called
  while the render mode is \%\f3GL_FEEDBACK\fP,
  or if \%\f3glRenderMode\fP is called with argument \%\f3GL_FEEDBACK\fP before
  \%\f3glFeedbackBuffer\fP is called at least once.
  .P
  \%\f3GL_INVALID_OPERATION\fP is generated if \%\f3glRenderMode\fP
  is executed between the execution of \%\f3glBegin\fP
  and the corresponding execution of \%\f3glEnd\fP.
  .SH ASSOCIATED GETS
  \%\f3glGet\fP with argument \%\f3GL_RENDER_MODE\fP
  .SH SEE ALSO
  \%\f3glFeedbackBuffer(3G)\fP,
  \%\f3glInitNames(3G)\fP,
  \%\f3glLoadName(3G)\fP,
  \%\f3glPassThrough(3G)\fP,
  \%\f3glPushName(3G)\fP,
  \%\f3glSelectBuffer(3G)\fP