sourCEntral - mobile manpages

pdf

CLGETMEMOBJECTINFO

NAME

clGetMemObjectInfo − Get information that is common to all memory objects (buffer and image objects).

cl_int clGetMemObjectInfo(cl_mem memobj, cl_mem_info param_name,size_t param_value_size, void *param_value,size_t *param_value_size_ret);PARAMETERS

memobj

Specifies the memory object being queried.

param_name

Specifies the information to query. The list of supported param_name types and the information returned in param_value by clGetMemObjectInfo is described in the table below.

param_value

A pointer to memory where the appropriate result being queried is returned. If param_value is NULL, it is ignored.

param_value_size

Used to specify the size in bytes of memory pointed to by param_value. This size must be ≥ size of return type as described in the table above.

param_value_size_ret

Returns the actual size in bytes of data being queried by param_value. If param_value_size_ret is NULL, it is ignored.

ERRORS

Returns CL_SUCCESS if the function is executed successfully. Otherwise, it returns one of the following errors:

• CL_INVALID_VALUE if param_name is not valid, or if size in bytes specified by param_value_size is < the size of return type as described in the table above and param_value is not NULL.

• CL_INVALID_MEM_OBJECT if memobj is a not a valid memory 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_D3D10_RESOURCE_KHR If the cl_khr_d3d10_sharing(3clc) extension is enabled and if param_name is CL_MEM_D3D10_RESOURCE_KHR and memobj was not created by the function clCreateFromD3D10BufferKHR(3clc), clCreateFromD3D10Texture2DKHR(3clc), or clCreateFromD3D10Texture3DKHR(3clc).

• CL_INVALID_DX9_MEDIA_SURFACE_KHR if param_name is CL_MEM_DX9_MEDIA_SURFACE_INFO_KHR and memobj was not created by the function clCreateFromDX9MediaSurfaceKHR(3clc) from a Direct3D9 surface. (If the cl_khr_dx9_media_sharing(3clc) extension is supported)

• CL_INVALID_D3D11_RESOURCE_KHR If the cl_khr_d3d11_sharing extension is supported, if param_name is CL_MEM_D3D11_RESOURCE_KHR and memobj was not created by the function clCreateFromD3D11BufferKHR(3clc), clCreateFromD3D11Texture2DKHR(3clc), or clCreateFromD3D11Texture3DKHR(3clc)."

SPECIFICATION

OpenCL Specification [1]

SEE ALSO

clGetImageInfo(3clc)

AUTHORS

The Khronos Group

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.

NOTES

1.

OpenCL Specification

page 125, section 5.4.5 - Memory Object Queries

pdf