'\" t
.\"     Title: glGetInternalFormativ
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 05/30/2012
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "GLGETINTERNALFORMATI" "3G" "05/30/2012" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
glGetInternalFormativ \- retrieve information about implementation\-dependent support for internal formats
.SH "C SPECIFICATION"
.HP \w'void\ glGetInternalFormativ('u
.BI "void glGetInternalFormativ(GLenum\ " "target" ", GLenum\ " "internalformat" ", GLenum\ " "pname" ", GLsizei\ " "bufSize" ", GLint\ *" "params" ");"
.SH "PARAMETERS"
.PP
\fItarget\fR
.RS 4
Indicates the usage of the internal format\&.
\fItarget\fR
must be
\fBGL_RENDERBUFFER\fR,
\fBGL_TEXTURE_2D_MULTISAMPLE\fR
or
\fBGL_TEXTURE_2D_MULTISAMPLE_ARRAY\fR\&.
.RE
.PP
\fIinternalformat\fR
.RS 4
Specifies the internal format about which to retrieve information\&.
.RE
.PP
\fIpname\fR
.RS 4
Specifies the type of information to query\&.
.RE
.PP
\fIbufSize\fR
.RS 4
Specifies the maximum number of basic machine units that may be written to
\fIparams\fR
by the function\&.
.RE
.PP
\fIparams\fR
.RS 4
Specifies the address of a variable into which to write the retrieved information\&.
.RE
.SH "DESCRIPTION"
.PP

\fBglGetInternalFormativ\fR
retrieves information about implementation\-dependent support for internal formats\&.
\fItarget\fR
indicates the target with which the internal format will be used and must be one of
\fBGL_RENDERBUFFER\fR,
\fBGL_TEXTURE_2D_MULTISAMPLE\fR, or
\fBGL_TEXTURE_2D_MULTISAMPLE_ARRAY\fR, corresponding to usage as a renderbuffer, two\-dimensional multisample texture or two\-dimensional multisample array texture, respectively\&.
.PP

\fIinternalformat\fR
specifies the internal format about which to retrieve information and must be a color\-renderable, depth\-renderable or stencil\-renderable format\&.
.PP
The information retrieved will be written to memory addressed by the pointer specified in
\fIparams\fR\&. No more than
\fIbufSize\fR
basic machine units will be written to this memory\&.
.PP
If
\fIpname\fR
is
\fBGL_NUM_SAMPLE_COUNTS\fR, the number of sample counts that would be returned by querying
\fBGL_SAMPLES\fR
will be returned in
\fIparams\fR\&.
.PP
If
\fIpname\fR
is
\fBGL_SAMPLES\fR, the sample counts supported for
\fIinternalformat\fR
and
\fItarget\fR
are written into
\fIparams\fR
in descending numeric order\&. Only positive values are returned\&. Querying
\fBGL_SAMPLES\fR
with
\fIbufSize\fR
of one will return just the maximum supported number of samples for this format\&. The maximum value in
\fBGL_SAMPLES\fR
is guaranteed to be at least the lowest of the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The value of \fBGL_MAX_INTEGER_SAMPLES\fR if \fIinternalformat\fR is a signed or unsigned integer format\&..RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The value of \fBGL_MAX_DEPTH_TEXTURE_SAMPLES\fR if \fIinternalformat\fR is a depth\- or stencil\-renderable format and
                \fItarget\fR is \fBGL_TEXTURE_2D_MULTISAMPLE\fR, \fBGL_TEXTURE_2D_MULTISAMPLE_ARRAY\fR\&..RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The value of \fBGL_MAX_COLOR_TEXTURE_SAMPLES\fR if \fIinternalformat\fR is a color\-renderable format and
                \fItarget\fR is \fBGL_TEXTURE_2D_MULTISAMPLE\fR or \fBGL_TEXTURE_2D_MULTISAMPLE_ARRAY\fR\&..RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The value of \fBGL_MAX_SAMPLES\fR\&..RE
.sp
.SH "NOTES"
.PP

\fBglGetInternalFormativ\fR
is available only if the GL version is 4\&.2 or higher\&.
.SH "ERRORS"
.PP

\fBGL_INVALID_VALUE\fR
is generated if
\fIbufSize\fR
is negative\&.
.PP

\fBGL_INVALID_ENUM\fR
is generated if
\fIpname\fR
is not
\fBGL_SAMPLES\fR
or
\fBGL_NUM_SAMPLE_COUNTS\fR\&.
.PP

\fBGL_INVALID_ENUM\fR
is generated if
\fIinternalformat\fR
is not color\-, depth\-, or stencil\-renderable\&.
.PP

\fBGL_INVALID_ENUM\fR
is generated if
\fItarget\fR
is not one of
\fBGL_TEXTURE_2D_MULTISAMPLE\fR,
\fBGL_TEXTURE_2D_MULTISAMPLE_ARRAY\fR
or
\fBGL_RENDERBUFFER\fR\&.
.SH "SEE ALSO"
.PP

\fBglGet\fR()
.SH "COPYRIGHT"
.PP
Copyright
\(co
2011 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\&.
\m[blue]\fBhttp://opencontent\&.org/openpub/\fR\m[]\&.