cl_ext_image_from_buffer

cl_ext_image_from_buffer

Please see the Issues list in the Khronos OpenCL-Docs repository:
https://github.com/KhronosGroup/OpenCL-Docs

Kevin Petit, Arm Ltd.
Jeremy Kemp, Imagination Technologies
Alastair Murray, Codeplay Software Ltd.
Balaji Calidas, Qualcomm

Copyright 2008-2023 The Khronos Group Inc.

This Specification is protected by copyright laws and contains material proprietary to Khronos. Except as described by these terms, it or any components may not be reproduced, republished, distributed, transmitted, displayed, broadcast or otherwise exploited in any manner without the express prior written permission of Khronos.

This Specification has been created under the Khronos Intellectual Property Rights Policy, which is Attachment A of the Khronos Group Membership Agreement available at www.khronos.org/files/member_agreement.pdf and defines the terms 'Scope', 'Compliant Portion', and 'Necessary Patent Claims'.

Khronos grants a conditional copyright license to use and reproduce the unmodified Specification for any purpose, without fee or royalty, EXCEPT no licenses to any patent, trademark or other intellectual property rights are granted under these terms. Parties desiring to implement the Specification and make use of Khronos trademarks in relation to that implementation, and receive reciprocal patent license protection under the Khronos Intellectual Property Rights Policy must become Adopters and confirm the implementation as conformant under the process defined by Khronos for this Specification; see https://www.khronos.org/adopters.

Khronos makes no, and expressly disclaims any, representations or warranties, express or implied, regarding this Specification, including, without limitation: merchantability, fitness for a particular purpose, non-infringement of any intellectual property, correctness, accuracy, completeness, timeliness, and reliability. Under no circumstances will Khronos, or any of its Promoters, Contributors or Members, or their respective partners, officers, directors, employees, agents or representatives be liable for any damages, whether direct, indirect, special or consequential damages for lost revenues, lost profits, or otherwise, arising from or in connection with these materials.

Where this Specification identifies specific sections of external references, only those specifically identified sections define normative functionality. The Khronos Intellectual Property Rights Policy excludes external references to materials and associated enabling technology not created by Khronos from the Scope of this specification, and any licenses that may be required to implement such referenced materials and associated technologies must be obtained separately and may involve royalty payments.

Khronos® and Vulkan® are registered trademarks, and SPIR™, SPIR-V™, and SYCL™ are trademarks of The Khronos Group Inc. OpenCL™ is a trademark of Apple Inc. used under license by Khronos. OpenGL® is a registered trademark and the OpenGL ES™ and OpenGL SC™ logos are trademarks of Hewlett Packard Enterprise used under license by Khronos. All other product names, trademarks, and/or company names are used solely for identification and belong to their respective owners.

Shipping.

Built On: 2023-06-14
Version: 1.0.0

This extension is written against the OpenCL Specification version 3.0.9.

This extension requires OpenCL 3.0.

This extension requires cl_ext_image_requirements_info.

This extension enables all types of images to be created from an existing buffer object.

Accepted value for the param_name parameter to clGetImageRequirementsInfoEXT:

image_format is a pointer to a structure that describes format properties of the image to be allocated. An image can be created from a buffer by specifying a buffer object in the image_desc→_mem_object_. A 2D image can be created from another 2D image object by specifying an image object in the image_desc→_mem_object_. Refer to the Image Format Descriptor section for a detailed description of the image format descriptor.

CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if a 2D image is created from a buffer and the row pitch and base address alignment does not follow the rules described for creating a 2D image from a buffer.

CL_INVALID_IMAGE_FORMAT_DESCRIPTOR if an image is created from a buffer and the row or slice pitch and base address alignment do not follow the rules described for creating an image from a buffer.

CL_INVALID_IMAGE_SIZE if an image is created from a buffer and the buffer passed in image_desc→_mem_object is too small to be used as a data store for the image, e.g. if its size is smaller than the value returned for CL_IMAGE_REQUIREMENTS_SIZE_EXT for the parameters used to create the image.

For a 2D image created from a buffer, the pitch specified (or computed if pitch specified is 0) must be a multiple of the maximum of the CL_DEVICE_IMAGE_PITCH_ALIGNMENT value for all devices in the context associated with the buffer specified by mem_object that support images.

For an image created from a buffer, the pitch specified (or computed if pitch specified is 0) must be a multiple of the CL_IMAGE_REQUIREMENTS_ROW_PITCH_ALIGNMENT_EXT value for the image_format, image_type and flags used to create the image.

For an image created from a buffer, the pitch specified (or computed if pitch specified is 0) must be a multiple of the CL_IMAGE_REQUIREMENTS_SLICE_PITCH_ALIGNMENT_EXT value for the image_format, image_type and flags used to create the image.

mem_object may refer to a valid buffer or image memory object. mem_object can be a buffer memory object if image_type is CL_MEM_OBJECT_IMAGE1D_BUFFER or CL_MEM_OBJECT_IMAGE2D. mem_object can be an image object if image_type is CL_MEM_OBJECT_IMAGE2D. Otherwise it must be NULL. The image pixels are taken from the memory objects data store. When the contents of the specified memory objects data store are modified, those changes are reflected in the contents of the image object and vice-versa at corresponding synchronization points.

mem_object may refer to a valid buffer or image memory object. mem_object can be an image object if image_type is CL_MEM_OBJECT_IMAGE2D. Otherwise it must be NULL. The image pixels are taken from the memory objects data store. When the contents of the specified memory objects data store are modified, those changes are reflected in the contents of the image object and vice-versa at corresponding synchronization points.

For a 1D image created from a buffer object, the image_width × size of element in bytes must be ≤ size of the buffer object. The image data in the buffer object is stored as a single scanline which is a linear sequence of adjacent elements.

For a 1D image array created from a buffer object, the image_slice_pitch × image_array_size must be ≤ size of the buffer object specified by mem_object. The image data in the buffer object is stored as a linear sequence of adjacent 1D slices. Each slice is a single scanline padded to image_slice_pitch bytes. Each scanline is a linear sequence of image elements.

For a 2D image array created from a buffer object, the image_slice_pitch × image_array_size must be ≤ size of the buffer object specified by mem_object. The image data in the buffer object is stored as a linear sequence of adjacent 2D slices. Each slice is a linear sequence of adjacent scanlines padded to image_slice_pitch bytes. Each scanline is a linear sequence of image elements padded to image_row_pitch bytes.

For a 3D image created from a buffer object, the image_slice_pitch × image_depth must be ≤ size of the buffer object specified by mem_object. The image data in the buffer object is stored as a linear sequence of adjacent 2D slices padded to image_slice_pitch bytes. Each slice is a linear sequence of adjacent scanlines. Each scanline is a linear sequence of image elements padded to image_row_pitch bytes.

Concurrent reading from, writing to and copying between both a buffer object and 1D image buffer or 2D image object associated with the buffer object is undefined. Only reading from both a buffer object and 1D image buffer or 2D image object associated with the buffer object is defined.

Concurrent reading from, writing to and copying between both a buffer object and an image object associated with the buffer object is undefined. Only reading from both a buffer object and image object associated with the buffer object is defined.

The following is added to the _List of supported param_names by clGetImageRequirementsInfoEXT:

None.

None.