clGetMemObjectInfo

Used to 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.

cl_mem_info Return Type Info. returned in param_value
CL_MEM_TYPE cl_mem_object_type Returns one of the following values:

CL_MEM_OBJECT_BUFFER if memobj is created with clCreateBuffer or clCreateSubBuffer,

CL_MEM_OBJECT_IMAGE2D if memobj is a 2D image object, or

CL_MEM_OBJECT_IMAGE3D if memobj is a 3D image object.

CL_MEM_FLAGS cl_mem_flags Returns the flags argument value specified when memobj is created with clCreateBuffer, clCreateSubBuffer, clCreateImage2D, or clCreateImage3D.
CL_MEM_SIZE size_t Return actual size of the data store associated with memobj in bytes.
CL_MEM_HOST_PTR void * Return the host_ptr argument value specified when memobj is created.
CL_MEM_MAP_COUNT cl_uint Map count. The map count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for debugging.
CL_MEM_REFERENCE_COUNT cl_uint Return memobj reference count. The reference count returned should be considered immediately stale. It is unsuitable for general use in applications. This feature is provided for identifying memory leaks.
CL_MEM_CONTEXT cl_context Return context specified when memory object is created.
CL_MEM_ASSOCIATED_MEMOBJECT cl_mem Return memory object from which memobj is created.

This returns the memory object specified as buffer argument to clCreateSubBuffer.

Otherwise a NULL value is returned.

CL_MEM_OFFSET size_t Return offset if memobj is a sub-buffer object created using clCreateSubBuffer.

This return 0 if memobj is not a subbuffer object.

CL_MEM_D3D10_RESOURCE_KHR ID3D10Resource * The propery being queried (if the cl_khr_d3d10_sharing extension is enabled). If memobj was created using clCreateFromD3D10BufferKHR, clCreateFromD3D10Texture2DKHR, or clCreateFromD3D10Texture3DKHR, returns the resource argument specified when memobj was created.
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 greater than or equal to 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 less than the size of return type as described in the table above and param_value is not NULL.
  • CL_INVALID_D3D10_RESOURCE_KHR If the cl_khr_d3d10_sharing extension is enabled and if param_name is CL_MEM_D3D10_RESOURCE_KHR and memobj was not created by the function clCreateFromD3D10BufferKHR, clCreateFromD3D10Texture2DKHR, or clCreateFromD3D10Texture3DKHR.
  • 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.

Specification

OpenCL Specification

Also see

clGetImageInfo

Copyright © 2007-2010 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.