'\" t
.\"     Title: clGetPlatformInfo
.\"    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 "CLGETPLATFORMINFO" "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"
clGetPlatformInfo \- Get specific information about the OpenCL platform\&.
.SH ""
.HP \w'cl_int\ clGetPlatformInfo('u
.BI "cl_int clGetPlatformInfo(cl_platform_id\ " "platform" ", cl_platform_info\ " "param_name" ", size_t\ " "param_value_size" ", void\ *" "param_value" ", size_t\ *" "param_value_size_ret" ");"
.SH "PARAMETERS"
.PP
\fIplatform\fR
.RS 4
The platform ID returned by
\fBclGetPlatformIDs\fR(3clc)
or can be NULL\&. If
\fIplatform\fR
is NULL, the behavior is implementation\-defined\&.
.RE
.PP
\fIparam_name\fR
.RS 4
An enumeration constant that identifies the platform information being queried\&. It can be one of the values specified in the table below\&.
.RE
.PP
\fIparam_value\fR
.RS 4
A pointer to memory location where appropriate values for a given
\fIparam_value\fR
will be returned\&. Possible
\fIparam_value\fR
values returned are listed in the table below\&. If
\fIparam_value\fR
is NULL, it is ignored\&.
.RE
.PP
\fIparam_value_size\fR
.RS 4
Specifies the size in bytes of memory pointed to by
\fIparam_value\fR\&. This size in bytes must be ≥ size of return type specified in the table below\&.
.RE
.PP
\fIparam_value_size_ret\fR
.RS 4
Returns the actual size in bytes of data being queried by
\fIparam_value\fR\&. If
\fIparam_value_size_ret\fR
is NULL, it is ignored
.RE
.PP
.RS 4
OpenCL Platform Queries
.TS
allbox tab(:);
lB lB lB.
T{
cl_platform_info
T}:T{
Return Type
T}:T{
Description
T}
.T&
l l l
l l l
l l l
l l l
l l l.
T{
\fBCL_PLATFORM_PROFILE\fR
T}:T{
char[]
T}:T{
OpenCL profile string\&. Returns the profile name supported by the implementation\&. The profile name returned can be one of the following strings:
.sp
FULL_PROFILE \- if the implementation supports the OpenCL specification (functionality defined as part of the core specification and does not require any extensions to be supported)\&.
.sp
EMBEDDED_PROFILE \- if the implementation supports the OpenCL embedded profile\&. The embedded profile is defined to be a subset for each version of OpenCL\&.
T}
T{
\fBCL_PLATFORM_VERSION\fR
T}:T{
char[]
T}:T{
OpenCL version string\&. Returns the OpenCL version supported by the implementation\&. This version string has the following format:
.sp
\fIOpenCL<space><major_version\&.minor_version><space><platform\-specific information>\fR
.sp
The
\fImajor_version\&.minor_version\fR
value returned will be 1\&.2\&.
T}
T{
\fBCL_PLATFORM_NAME\fR
T}:T{
char[]
T}:T{
Platform name string\&.
T}
T{
\fBCL_PLATFORM_VENDOR\fR
T}:T{
char[]
T}:T{
Platform vendor string\&.
T}
T{
\fBCL_PLATFORM_EXTENSIONS\fR
T}:T{
char[]
T}:T{
Returns a space\-separated list of extension names (the extension names themselves do not contain any spaces) supported by the platform\&. Extensions defined here must be supported by all devices associated with this platform\&.
T}
.TE
.sp 1
.RE
.SH "NOTES"
.PP
A null terminated string is returned by OpenCL query function calls if the return type of the information being queried is a char[]\&.
.SH "ERRORS"
.PP
Returns
CL_SUCCESS
if the function is executed successfully\&. Otherwise, it returns the following:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
CL_INVALID_PLATFORM if \fIplatform\fR is not a valid platform\&.
.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 one of
the supported values or if size in bytes specified by \fIparam_value_size\fR
is less than size of return type and \fIparam_value\fR is not a NULL value\&.
.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
\fBclGetPlatformIDs\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 33, section 4.1 - Querying Platform Info
.RE