'\" t
.\"     Title: clGetSamplerInfo
.\"    Author: The Khronos Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/14/2021
.\"    Manual: OpenCL Manual
.\"    Source: The Khronos Group
.\"  Language: English
.\"
.TH "CLGETSAMPLERINFO" "3clc" "01/14/2021" "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"
clGetSamplerInfo \- Returns information about the sampler object\&.
.SH ""
.HP \w'cl_int\ clGetSamplerInfo('u
.BI "cl_int clGetSamplerInfo(cl_sampler\ " "sampler" ", cl_sampler_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fIsampler\fR
.RS 4
Specifies the sampler being queried\&.
.RE
.PP
\fIparam_name\fR
.RS 4
Specifies the information to query\&. The list of supported
\fIparam_name\fR
types and the information returned in
\fIparam_value\fR
by
\fBclGetSamplerInfo\fR
is described in the table below\&.
.TS
allbox tab(:);
lB lB.
T{
cl_sampler_info
T}:T{
Return Type and Info\&. returned in \fIparam_value\fR
T}
.T&
l l
l l
l l
l l
l l.
T{
\fBCL_SAMPLER_REFERENCE_COUNT\fR
T}:T{
Return type: cl_uint

Return the
\fIsampler\fR
reference count\&. The reference count returned should be considered immediately stale\&. It is unsuitable for general use in applications\&. This feature is provided for identifying memory leaks\&.
T}
T{
\fBCL_SAMPLER_CONTEXT\fR
T}:T{
Return type: cl_context

Return the context specified when the sampler is created\&.
T}
T{
\fBCL_SAMPLER_NORMALIZED_COORDS\fR
T}:T{
Return type: cl_bool

Return the normalized coords value associated with
\fIsampler\fR\&.
T}
T{
\fBCL_SAMPLER_ADDRESSING_MODE\fR
T}:T{
Return type: cl_addressing_mode

Return the addressing mode value associated with
\fIsampler\fR\&.
T}
T{
\fBCL_SAMPLER_FILTER_MODE\fR
T}:T{
Return type: cl_filter_mode

Return the filter mode value associated with
\fIsampler\fR\&.
T}
.TE
.sp 1
.RE
.PP
\fIparam_value \fR
.RS 4
A pointer to memory where the appropriate result being queried is returned\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\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 above\&.
.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\&.
.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_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
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_SAMPLER if   \fIsampler\fR is a
not a valid sampler object\&.
.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
\fBclCreateSampler\fR(3clc),
\fBclRetainSampler\fR(3clc),
\fBclReleaseSampler\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 130, section 5.5.2 - Sampler Object Queries
.RE