GlClearStencil: Difference between revisions

From QB64 Phoenix Edition Wiki
Jump to navigation Jump to search
(Created page with "'''_glClearStencil:''' specify the clear value for the stencil buffer {{PageSyntax}} :: SUB _glClearStencil (BYVAL s AS LONG) :: void '''_glClearStencil'''(GLint {{Parameter|s}}); ; s : Specifies the index used when the stencil buffer is cleared. The initial value is 0. {{PageDescription}} '''_glClearStencil''' specifies the index used by {{KW|_glClear}} to clear the stencil buffer. {{Parameter|s}} is masked with 2<sup>m</sup> - 1, where m is the nu...")
 
No edit summary
Line 1: Line 1:
'''_glClearStencil:''' specify the clear value for the stencil buffer
{{DISPLAYTITLE:_glClearStencil}}
The '''_glClearStencil''' statement specifies the clear value for the stencil buffer.




{{PageSyntax}}
{{PageSyntax}}
: '''_glClearStencil''' GLint {{Parameter|s}}


::  SUB _glClearStencil (BYVAL s AS LONG)
::  void '''_glClearStencil'''(GLint {{Parameter|s}});


 
{{PageParameters}}
; s
* OpenGL is using its own set of variable types to describe its command parameters.
: Specifies the index used when the stencil buffer is cleared. The initial value is 0.
* Use the following table to find the respective QB64 [[Variable Types]].
{{TextStart}}
  '''OpenGL'''    |    '''C/C++'''        |        '''QB64'''
------------+------------------+----------------------
GLenum      |  unsigned int    |  [[_UNSIGNED]] [[LONG]]
GLboolean  |  unsigned char  |  [[_UNSIGNED]] [[_BYTE]]
GLbitfield  |  unsigned int    |  [[_UNSIGNED]] [[LONG]]
GLbyte      |  signed char    |  [[_BYTE]]
GLshort    |  short          |  [[INTEGER]]
GLint      |  int            |  [[LONG]]
GLsizei    |  int            |  [[LONG]]
GLubyte    |  unsigned char  |  [[_UNSIGNED]] [[_BYTE]]
GLushort    |  unsigned short  |  [[_UNSIGNED]] [[INTEGER]]
GLuint      |  unsigned int    |  [[_UNSIGNED]] [[LONG]]
GLfloat    |  float          |  [[SINGLE]]
GLclampf    |  float          |  [[SINGLE]]
GLdouble    |  double          |  [[DOUBLE]]
GLclampd    |  double          |  [[DOUBLE]]
GLvoid      |  void            |  no parameters used
{{TextEnd}}




{{PageDescription}}
{{PageDescription}}
 
* OpenGL's documentation is available in several places, so we won't reproduce it here for another time.
'''_glClearStencil''' specifies the index used by {{KW|_glClear}} to clear the stencil buffer. {{Parameter|s}} is masked with 2&lt;sup&gt;m&lt;/sup&gt; - 1, where m is the number of bits in the stencil buffer.
* The full description for this command can be found at [https://docs.microsoft.com/en-us/windows/win32/opengl/glclearstencil Microsoft Docs] and is also valid for QB64 usage.
 
 
{{PageUseWith}}
 
{{KW|_glGet}} with argument {{KW|_GL_STENCIL_CLEAR_VALUE}}
 
{{KW|_glGet}} with argument {{KW|_GL_STENCIL_BITS}}




{{PageSeeAlso}}
{{PageSeeAlso}}
* [[_GL|SUB _GL]]


[[_GL|SUB _GL]]
{{KW|_glClear}}


{{PageNavigation}}


{{PageCopyright}}
[[Category:Final]]

Revision as of 15:13, 14 July 2022

The _glClearStencil statement specifies the clear value for the stencil buffer.


Syntax

_glClearStencil GLint s


Parameters

  • OpenGL is using its own set of variable types to describe its command parameters.
  • Use the following table to find the respective QB64 Variable Types.
  OpenGL     |     C/C++        |        QB64
 ------------+------------------+----------------------
 GLenum      |  unsigned int    |  _UNSIGNED LONG
 GLboolean   |  unsigned char   |  _UNSIGNED _BYTE
 GLbitfield  |  unsigned int    |  _UNSIGNED LONG
 GLbyte      |  signed char     |  _BYTE
 GLshort     |  short           |  INTEGER
 GLint       |  int             |  LONG
 GLsizei     |  int             |  LONG
 GLubyte     |  unsigned char   |  _UNSIGNED _BYTE
 GLushort    |  unsigned short  |  _UNSIGNED INTEGER
 GLuint      |  unsigned int    |  _UNSIGNED LONG
 GLfloat     |  float           |  SINGLE
 GLclampf    |  float           |  SINGLE
 GLdouble    |  double          |  DOUBLE
 GLclampd    |  double          |  DOUBLE
 GLvoid      |  void            |  no parameters used


Description

  • OpenGL's documentation is available in several places, so we won't reproduce it here for another time.
  • The full description for this command can be found at Microsoft Docs and is also valid for QB64 usage.


See also



Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link