'\" t
.\"     Title: clGetGLTextureInfo
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 02/03/2019
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETGLTEXTUREINFO" "3clc" "02/03/2019" "The Khronos Group" "OpenCL 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"
clGetGLTextureInfo \- Returns additional information about the GL texture object associated with a memory object\&.
.SH ""
.HP \w'cl_int\ clGetGLTextureInfo('u
.BI "cl_int clGetGLTextureInfo(cl_mem\ " "memobj" ", cl_gl_texture_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fI param_name \fR
.RS 4
Specifies what additional information about the GL texture object associated with
\fImemobj\fR
to query\&. The list of supported
\fIparam_name\fR
types and the information returned in
\fIparam_value\fR
by
\fBclGetGLTextureInfo\fR
is described in the table
below\&.
.RE
.PP
\fI param_value \fR
.RS 4
A pointer to memory where the result being queried is returned\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fI \fR\fI\fR\fI param_value_size \fR
.RS 4
Specifies the size in bytes of memory pointed to by
\fIparam_value\fR\&. This size must be ≥ size of return type as described in the table below\&.
.RE
.PP
\fI param_value_size_ret \fR
.RS 4
Returns the actual size in bytes of data copied to
\fIparam_value\fR\&. If
\fIparam_value_size_ret\fR
is NULL, it is ignored\&.
.TS
allbox tab(:);
lB lB lB.
T{
cl_gl_texture_info
T}:T{
Return Type
T}:T{
Information returned in \fIparam_value\fR
T}
.T&
l l l
l l l.
T{
\fBCL_GL_TEXTURE_TARGET\fR
T}:T{
GLenum
T}:T{
The \fItexture_target\fR argument specified in
\fBclCreateFromGLTexture\fR(3clc)\&.
T}
T{
\fBCL_GL_MIPMAP_LEVEL\fR
T}:T{
GLint
T}:T{
The \fImiplevel\fR argument specified in
\fBclCreateFromGLTexture\fR(3clc)\&.
T}
.TE
.sp 1
.RE
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise, it returns one of the following errors:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_MEM_OBJECT if \fImemobj\fR
is not a valid OpenCL memory object
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_GL_OBJECT if there is no GL texture object
associated with \fImemobj\fR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_VALUE if \fIparam_name\fR is not
valid, or if size in bytes specified by \fIparam_value_size\fR
is < size of return type as described in the table above and
\fIparam_value\fR is not NULL, or if \fIparam_value\fR
and \fIparam_value_size_ret\fR are NULL\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_RESOURCES if there is a failure to allocate
resources required by the OpenCL implementation on the device\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_OUT_OF_HOST_MEMORY if there is a failure to allocate
resources required by the OpenCL implementation on the host\&.
.RE
.SH "SPECIFICATION"
.PP
\m[blue]\fBOpenCL Specification\fR\m[]\&\s-2\u[1]\d\s+2
.SH "SEE ALSO"
.PP
\fBcl_khr_gl_sharing\fR(3clc),
\fBclGetGLObjectInfo\fR(3clc),
\fBclCreateFromGLTexture\fR(3clc),
\fBclCreateFromGLTexture\fR(3clc)
.SH "AUTHORS"
.PP
\fBThe Khronos Group\fR
.SH "COPYRIGHT"
.br
Copyright \(co 2007-2011 The Khronos Group Inc.
.br
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and/or associated documentation files (the "Materials"), to deal in the Materials without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Materials, and to permit persons to whom the Materials are furnished to do so, subject to the condition that this copyright notice and permission notice shall be included in all copies or substantial portions of the Materials.
.sp
.SH "NOTES"
.IP " 1." 4
OpenCL Specification
.RS 4
\%page 55, section 9.7.5 - Querying GL object information from a CL...
.RE