../config/attribs.txt {generated}/api/api-dictionary-no-links.asciidoc :source-highlighter: coderay
Khronos® OpenCL Working Group
Please see the Issues list in the Khronos OpenCL-Docs repository:
https://github.com/KhronosGroup/OpenCL-Docs
This extension is written against the OpenCL Specification version 3.0.10.
This extension requires OpenCL 3.0.
This extension requires cl_ext_image_tiling_control.
This extension requires cl_ext_image_requirements_info.
This extension makes it possible to use DRM format modifiers to control the tiling of images.
New valid value for cl_image_tiling_ext:
#define CL_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT 3New error code returned by clCreateImageWithProperties:
#define CL_IMAGE_FORMAT_REQUIRES_DRM_FORMAT_MODIFIER_EXT -1109Accepted value for the properties parameter to clCreateImageWithProperties:
CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT 0x4237Accepted value for the param_name parameter to clGetImageInfo:
CL_IMAGE_DRM_FORMAT_MODIFIER_EXT 0x4238Accepted value for the param_name parameter to clGetImageRequirementsInfoEXT:
CL_IMAGE_REQUIREMENTS_SUPPORTED_DRM_FORMAT_MODIFIERS_EXT 0x4239
CL_IMAGE_REQUIREMENTS_DRM_FORMAT_MODIFIER_REQUIRED_EXT 0x423A- (Modify section 5.3.X, Querying Image requirements)
-
The following is added to Table XX: List of supported param_names by *clGetImageRequirementsInfoEXT*:
Image Format Info Return type Info. returned in param_value {CL_IMAGE_REQUIREMENTS_SUPPORTED_DRM_FORMAT_MODIFIERS_EXT}
{cl_ulong_TYPE}[]
Return an array of supported DRM format modifiers that can be passed via {CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT} when creating an image using the parameters passed to {clGetImageRequirementsInfoEXT}. image_desc is allowed to be
NULL. When image_desc isNULL, each of the modifiers returned must be correct for all possible values of image_desc.{CL_IMAGE_REQUIREMENTS_DRM_FORMAT_MODIFIER_REQUIRED_EXT}
{cl_bool_TYPE}
Returns a boolean specifying whether providing a DRM format modifier via {CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT} is required when creating an image using the parameters passed to {clGetImageRequirementsInfoEXT}.
- (Modify section 5.3.1, Creating Image Objects)
-
The following additional values for the {CL_MEM_IMAGE_TILING_EXT} property are accepted:
-
{CL_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT} requires image data be laid out according to the DRM format modifier passed via the {CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT} property. Applications are required to provide a value for {CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT} when they set {CL_MEM_IMAGE_TILING_EXT} to {CL_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT}.
{CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT} can be passed as part of the properties parameter to clCreateImageWithProperties to provide the DRM format modifier that describes the layout of image data when an image is created with {CL_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT}.
The following error can be returned by clCreateImageWithProperties:
-
{CL_IMAGE_FORMAT_REQUIRES_DRM_FORMAT_MODIFIER_EXT} when a DRM format modifier is required to create an image with a specific combination of parameters but was not provided. Applications can use {CL_IMAGE_REQUIREMENTS_DRM_FORMAT_MODIFIER_REQUIRED_EXT} to determine whether a DRM format modifier is required or not.
-
- (Modify section 5.3.7, Image Object Queries)
-
The following is added to Table 22: List of supported param_names by *clGetImageInfo*:
| Image info | Return Type | Description |
|---|---|---|
{CL_IMAGE_DRM_FORMAT_MODIFIER_EXT} |
{cl_ulong_TYPE} |
If the image was created with the {CL_MEM_IMAGE_TILING_EXT} property set to {CL_IMAGE_TILING_DRM_FORMAT_MODIFIER_EXT}, return the value that was passed for {CL_MEM_IMAGE_DRM_FORMAT_MODIFIER_EXT}, otherwise return 0. |