Skip to content

pass vectors by reference in getters #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bashbaug merged 2 commits into from
Oct 1, 2025
Merged

pass vectors by reference in getters #335

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a52e4d6
pass vectors by reference in getters
Richardk2n Sep 30, 2025
8dab0db
remove redundant comments and checks
Richardk2n Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 81 additions & 41 deletions include/CL/opencl.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2882,12 +2882,9 @@ class Platform : public detail::Wrapper<cl_platform_id>
*/
cl_int getDevices(
cl_device_type type,
vector<Device>* devices) const
vector<Device>& devices) const
{
cl_uint n = 0;
if( devices == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_DEVICE_IDS_ERR);
}
cl_int err = CL_(clGetDeviceIDs)(object_, type, 0, nullptr, &n);
if (err != CL_SUCCESS && err != CL_DEVICE_NOT_FOUND) {
return detail::errHandler(err, __GET_DEVICE_IDS_ERR);
Expand All @@ -2905,18 +2902,31 @@ class Platform : public detail::Wrapper<cl_platform_id>
// with safe construction
// We must retain things we obtain from the API to avoid releasing
// API-owned objects.
if (devices) {
devices->resize(ids.size());
devices.resize(ids.size());

// Assign to param, constructing with retain behaviour
// to correctly capture each underlying CL object
for (size_type i = 0; i < ids.size(); i++) {
(*devices)[i] = Device(ids[i], true);
}
// Assign to param, constructing with retain behaviour
// to correctly capture each underlying CL object
for (size_type i = 0; i < ids.size(); i++) {
devices[i] = Device(ids[i], true);
}
return CL_SUCCESS;
}

/*! \brief Gets a list of devices for this platform.
*
* Pointer overload for backwards compatibility.
*/
cl_int getDevices(
cl_device_type type,
vector<Device>* devices) const
{
if( devices == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_DEVICE_IDS_ERR);
}

return getDevices(type, *devices);
}

#if defined(CL_HPP_USE_DX_INTEROP)
/*! \brief Get the list of available D3D10 devices.
*
Expand Down Expand Up @@ -2945,7 +2955,7 @@ class Platform : public detail::Wrapper<cl_platform_id>
cl_d3d10_device_source_khr d3d_device_source,
void * d3d_object,
cl_d3d10_device_set_khr d3d_device_set,
vector<Device>* devices) const
vector<Device>& devices) const
{
typedef CL_API_ENTRY cl_int (CL_API_CALL *PFN_clGetDeviceIDsFromD3D10KHR)(
cl_platform_id platform,
Expand All @@ -2956,10 +2966,6 @@ class Platform : public detail::Wrapper<cl_platform_id>
cl_device_id * devices,
cl_uint* num_devices);

if( devices == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_DEVICE_IDS_ERR);
}

static PFN_clGetDeviceIDsFromD3D10KHR pfn_clGetDeviceIDsFromD3D10KHR = nullptr;
#if CL_HPP_TARGET_OPENCL_VERSION >= 120
CL_HPP_INIT_CL_EXT_FCN_PTR_PLATFORM_(object_, clGetDeviceIDsFromD3D10KHR);
Expand Down Expand Up @@ -2998,32 +3004,43 @@ class Platform : public detail::Wrapper<cl_platform_id>
// with safe construction
// We must retain things we obtain from the API to avoid releasing
// API-owned objects.
if (devices) {
devices->resize(ids.size());
devices.resize(ids.size());

// Assign to param, constructing with retain behaviour
// to correctly capture each underlying CL object
for (size_type i = 0; i < ids.size(); i++) {
(*devices)[i] = Device(ids[i], true);
}
// Assign to param, constructing with retain behaviour
// to correctly capture each underlying CL object
for (size_type i = 0; i < ids.size(); i++) {
devices[i] = Device(ids[i], true);
}
return CL_SUCCESS;
}

/*! \brief Get the list of available D3D10 devices.
*
* Pointer overload for backwards compatibility.
*/
cl_int getDevices(
cl_d3d10_device_source_khr d3d_device_source,
void * d3d_object,
cl_d3d10_device_set_khr d3d_device_set,
vector<Device>* devices) const
{
if( devices == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_DEVICE_IDS_ERR);
}

return getDevices(d3d_device_source, d3d_object, d3d_device_set, *devices);
}
#endif

/*! \brief Gets a list of available platforms.
*
* Wraps clGetPlatformIDs().
*/
static cl_int get(
vector<Platform>* platforms)
vector<Platform>& platforms)
{
cl_uint n = 0;

if( platforms == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_PLATFORM_IDS_ERR);
}

cl_int err = CL_(clGetPlatformIDs)(0, nullptr, &n);
if (err != CL_SUCCESS) {
return detail::errHandler(err, __GET_PLATFORM_IDS_ERR);
Expand All @@ -3035,17 +3052,29 @@ class Platform : public detail::Wrapper<cl_platform_id>
return detail::errHandler(err, __GET_PLATFORM_IDS_ERR);
}

if (platforms) {
platforms->resize(ids.size());
platforms.resize(ids.size());

// Platforms don't reference count
for (size_type i = 0; i < ids.size(); i++) {
(*platforms)[i] = Platform(ids[i]);
}
// Platforms don't reference count
for (size_type i = 0; i < ids.size(); i++) {
platforms[i] = Platform(ids[i]);
}
return CL_SUCCESS;
}

/*! \brief Gets a list of available platforms.
*
* Pointer overload for backwards compatibility.
*/
static cl_int get(
vector<Platform>* platforms)
{
if( platforms == nullptr ) {
return detail::errHandler(CL_INVALID_ARG_VALUE, __GET_PLATFORM_IDS_ERR);
}

return get(*platforms);
}

/*! \brief Gets the first available platform.
*
* Wraps clGetPlatformIDs(), returning the first result.
Expand Down Expand Up @@ -3572,13 +3601,9 @@ class Context
cl_int getSupportedImageFormats(
cl_mem_flags flags,
cl_mem_object_type type,
vector<ImageFormat>* formats) const
vector<ImageFormat>& formats) const
{
cl_uint numEntries;

if (!formats) {
return CL_SUCCESS;
}

cl_int err = CL_(clGetSupportedImageFormats)(
object_,
Expand All @@ -3604,16 +3629,31 @@ class Context
return detail::errHandler(err, __GET_SUPPORTED_IMAGE_FORMATS_ERR);
}

formats->assign(value.begin(), value.end());
formats.assign(value.begin(), value.end());
}
else {
// If no values are being returned, ensure an empty vector comes back
formats->clear();
formats.clear();
}

return CL_SUCCESS;
}

/*! \brief Gets a list of supported image formats.
*
* Pointer overload for backwards compatibility.
*/
cl_int getSupportedImageFormats(
cl_mem_flags flags,
cl_mem_object_type type,
vector<ImageFormat>* formats) const
{
if (!formats) {
return CL_SUCCESS;
}
return getSupportedImageFormats(flags, type, *formats);
}

#if defined(cl_ext_image_requirements_info)
template <typename T>
cl_int getImageRequirementsInfoExt(cl_image_requirements_info_ext name,
Expand Down