C Specification

To create a new buffer object (referred to as a sub-buffer object) from an existing buffer object, call the function

cl_mem clCreateSubBuffer(
    cl_mem buffer,
    cl_mem_flags flags,
    cl_buffer_create_type buffer_create_type,
    const void* buffer_create_info,
    cl_int* errcode_ret);

Parameters

  • buffer must be a valid buffer object and cannot be a sub-buffer object.

  • flags is a bit-field that is used to specify allocation and usage information about the sub-buffer memory object being created and is described in the Memory Flags table. If the CL_​MEM_​READ_​WRITE, CL_​MEM_​READ_​ONLY, or CL_​MEM_​WRITE_​ONLY values are not specified in flags, they are inherited from the corresponding memory access qualifiers associated with buffer. The CL_​MEM_​USE_​HOST_​PTR, CL_​MEM_​ALLOC_​HOST_​PTR, and CL_​MEM_​COPY_​HOST_​PTR values cannot be specified in flags but are inherited from the corresponding memory access qualifiers associated with buffer. If CL_​MEM_​COPY_​HOST_​PTR is specified in the memory access qualifier values associated with buffer it does not imply any additional copies when the sub-buffer is created from buffer. If the CL_​MEM_​HOST_​WRITE_​ONLY, CL_​MEM_​HOST_​READ_​ONLY, or CL_​MEM_​HOST_​NO_​ACCESS values are not specified in flags, they are inherited from the corresponding memory access qualifiers associated with buffer.

  • buffer_create_type and buffer_create_info describe the type of buffer object to be created. The list of supported values for buffer_create_type and corresponding descriptor that buffer_create_info points to is described in the SubBuffer Attributes table.

Description

Table 1. List of supported buffer creation types by https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#clCreateSubBuffer
cl_buffer_create_type Description

CL_​BUFFER_​CREATE_​TYPE_​REGION

Missing before version 1.1.

Create a buffer object that represents a specific region in buffer.

buffer_create_info is a pointer to a https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#cl_buffer_region structure specifying a region of the buffer.

If buffer is created with CL_​MEM_​USE_​HOST_​PTR, the host_ptr associated with the buffer object returned is host_ptr + origin.

The buffer object returned references the data store allocated for buffer and points to the region specified by buffer_create_info in this data store.

clCreateSubBuffer returns CL_​SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors in errcode_ret:

  • CL_​INVALID_​MEM_​OBJECT if buffer is not a valid buffer object or is a sub-buffer object.

  • CL_​INVALID_​VALUE if buffer was created with CL_​MEM_​WRITE_​ONLY and flags specifies CL_​MEM_​READ_​WRITE or CL_​MEM_​READ_​ONLY, or if buffer was created with CL_​MEM_​READ_​ONLY and flags specifies CL_​MEM_​READ_​WRITE or CL_​MEM_​WRITE_​ONLY, or if flags specifies CL_​MEM_​USE_​HOST_​PTR or CL_​MEM_​ALLOC_​HOST_​PTR or CL_​MEM_​COPY_​HOST_​PTR.

  • CL_​INVALID_​VALUE if buffer was created with CL_​MEM_​HOST_​WRITE_​ONLY and flags specify CL_​MEM_​HOST_​READ_​ONLY, or if buffer was created with CL_​MEM_​HOST_​READ_​ONLY and flags specify CL_​MEM_​HOST_​WRITE_​ONLY, or if buffer was created with CL_​MEM_​HOST_​NO_​ACCESS and flags specify CL_​MEM_​HOST_​READ_​ONLY or CL_​MEM_​HOST_​WRITE_​ONLY.

  • CL_​INVALID_​VALUE if the value specified in buffer_create_type is not valid.

  • CL_​INVALID_​VALUE if value(s) specified in buffer_create_info (for a given buffer_create_type) is not valid or if buffer_create_info is NULL.

  • CL_​MEM_​OBJECT_​ALLOCATION_​FAILURE if there is a failure to allocate memory for sub-buffer object.

  • CL_​OUT_​OF_​RESOURCES if there is a failure to allocate resources required by the OpenCL implementation on the device.

  • CL_​OUT_​OF_​HOST_​MEMORY if there is a failure to allocate resources required by the OpenCL implementation on the host.

  • CL_​INVALID_​VALUE if the region specified by the https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#cl_buffer_region structure passed in buffer_create_info is out of bounds in buffer.

  • CL_​INVALID_​BUFFER_​SIZE if the size field of the https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#cl_buffer_region structure passed in buffer_create_info is 0.

  • CL_​MISALIGNED_​SUB_​BUFFER_​OFFSET if there are no devices in context associated with buffer for which the origin field of the https://www.khronos.org/registry/OpenCL/specs/2.2/html/OpenCL_API.html#cl_buffer_region structure passed in buffer_create_info is aligned to the CL_​DEVICE_​MEM_​BASE_​ADDR_​ALIGN value.

Concurrent reading from, writing to and copying between both a buffer object and its sub-buffer object(s) is undefined. Concurrent reading from, writing to and copying between overlapping sub-buffer objects created with the same buffer object is undefined. Only reading from both a buffer object and its sub-buffer objects or reading from multiple overlapping sub-buffer objects is defined.

See Also

Document Notes

For more information, see the OpenCL Specification

This page is extracted from the OpenCL Specification. Fixes and changes should be made to the Specification, not directly.

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.