Radeon Pro Solid State Graphics Api User Manual - page 6
Rev. 1.01
6
buffer_offset
[in]
Offset (in bytes) in the buffer object to which the function is writing.
It must be a multiple of
CL_FILE_BLOCK_SIZE_AMD.
size
[in]
Size (in bytes) of data being read.
It must be a multiple of CL_FILE_BLOCK_SIZE_AMD. If the file size isn’t
a multiple of the block size, read the end of the file by aligning the read size with the
next block multiple beyond the file size.
file
[in]
File object from which to copy.
file_offset
[in]
Offset (in bytes) for copying from the file; file_offset
must be a multiple of CL_FILE_BLOCK_SIZE_AMD.
event_wait_list and num_events_in_wait_list
[in, optional]
Specify events that must complete before the clEnqueueReadSsgFileAMD command can execute. If
event_wait_list is NULL, the command will proceed without waiting for events to finish. Also, if
event_wait_list is NULL, num_events_in_wait_list must be 0. Otherwise, the list of events to which
event_wait_list points must be valid and num_events_in_wait_list must be greater than 0. The events
specified in event_wait_list act as synchronization points, and the contexts associated with events in
event_wait_list and in command_queue must be the same. The memory associated with event_wait_list
can be reused or freed-up after the function returns.
event
[out, optional]
Returns an event object that identifies the clEnqueueReadSsgFileAMD command and can query the
command status or queue a wait for the command to finish executing. The event argument can be NULL,
in which case the application will be unable to query the command status or queue a wait for the
command to finish. Unless event_wait_list and event are both NULL, event should avoid referring to an
element of the event_wait_list array.
Return Value
Description
CL_SUCCESS
The function executed successfully.
CL_INVALID_FILE_OBJECT_AMD The file is invalid for OpenCL.
CL_INVALID_COMMAND_QUEUE Command_queue is an invalid host command queue.
CL_INVALID_CONTEXT
The contexts associated with command_queue and buffer are
different, or the context associated with command_queue and the
events in event_wait_list are different.
CL_INVALID_MEM_OBJECT
The buffer object is invalid.
CL_INVALID_VALUE
The region specified by buffer_offset, file_offset or size is out of
bounds or is misaligned with CL_FILE_BLOCK_SIZE_AMD.
CL_INVALID_EVENT_WAIT_LIST Event_wait_list is NULL and num_events_in_wait_list is greater than 0,
event_wait_list is not NULL and num_events_in_wait_list is 0, or the
event objects in event_wait_list are invalid.
CL_EXEC_STATUS_ERROR_FOR_EVENTS_IN_WAIT_LIST
Read operations are blocking, and the execution status of at least one
event in event_wait_list is a negative integer value.