clSetMemObjectDestructorCallback - Registers a user callback function with a memory object.
Contents
Copyright
Copyright © 2007-2011 The Khronos Group Inc.
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.
Errors
Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following
errors:
• CL_INVALID_MEM_OBJECT if memobj is not a valid memory object.
• CL_INVALID_VALUE if pfn_notify is NULL.
• 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.
Name
clSetMemObjectDestructorCallback - Registers a user callback function with a memory object.
cl_intclSetMemObjectDestructorCallback(cl_memmemobj,void(CL_CALLBACK*pfn_notify)(cl_memmemobj,
void *user_data),void*user_data);Notes
1. OpenCL Specification
page 119, section 5.4.1 - Retaining and Releasing Memory Objects
The Khronos Group 11/18/2024 CLSETMEMOBJECTDESTRU(3clc)
Parameters
memobj
A valid memory object.
pfn_notify
The callback function that can be registered by the application. This callback function may be called
asynchronously by the OpenCL implementation. It is the application's responsibility to ensure that
the callback function is thread-safe. The parameters to this callback function are:
• memobj: the memory object being deleted. When the user callback is called by the implementation,
this memory object is no longer valid. memobj is only provided for reference purposes.
• user_data: a pointer to user supplied data.
user_data
Data which will be passed as the user_data argument when pfn_notify is called. user_data can be
NULL.
See Also
clCreateCommandQueue(3clc), clGetCommandQueueInfo(3clc), clReleaseCommandQueue(3clc), clRetainCommandQueue(3clc)
Specification
OpenCLSpecification[1]
