Public Member Functions | Static Public Member Functions

Cloo.ComputeImage3D Class Reference

Represents an OpenCL 3D image. More...

Inheritance diagram for Cloo.ComputeImage3D:
Cloo.ComputeImage Cloo.ComputeMemory Cloo.ComputeResource Cloo.ComputeObject

List of all members.

Public Member Functions

 ComputeImage3D (ComputeContext context, ComputeMemoryFlags flags, ComputeImageFormat format, int width, int height, int depth, long rowPitch, long slicePitch, IntPtr data)
 Creates a new ComputeImage3D.

Static Public Member Functions

static ComputeImage3D CreateFromGLTexture3D (ComputeContext context, ComputeMemoryFlags flags, int textureTarget, int mipLevel, int textureId)
 Creates a new ComputeImage3D from an OpenGL 3D texture object.
static ICollection
< ComputeImageFormat
GetSupportedFormats (ComputeContext context, ComputeMemoryFlags flags)
 Gets a collection of supported ComputeImage3D ComputeImageFormats in a ComputeContext.

Detailed Description

Represents an OpenCL 3D image.

See also:
ComputeImage

Constructor & Destructor Documentation

Cloo.ComputeImage3D.ComputeImage3D ( ComputeContext  context,
ComputeMemoryFlags  flags,
ComputeImageFormat  format,
int  width,
int  height,
int  depth,
long  rowPitch,
long  slicePitch,
IntPtr  data 
)

Creates a new ComputeImage3D.

Parameters:
context A valid ComputeContext in which the ComputeImage3D is created.
flags A bit-field that is used to specify allocation and usage information about the ComputeImage3D.
format A structure that describes the format properties of the ComputeImage3D.
width The width of the ComputeImage3D in pixels.
height The height of the ComputeImage3D in pixels.
depth The depth of the ComputeImage3D in pixels.
rowPitch The size in bytes of each row of elements of the ComputeImage3D. If rowPitch is zero, OpenCL will compute the proper value based on ComputeImage.Width and ComputeImage.ElementSize.
slicePitch The size in bytes of each 2D slice in the ComputeImage3D. If slicePitch is zero, OpenCL will compute the proper value based on ComputeImage.RowPitch and ComputeImage.Height.
data The data to initialize the ComputeImage3D. Can be IntPtr.Zero.

Member Function Documentation

static ComputeImage3D Cloo.ComputeImage3D.CreateFromGLTexture3D ( ComputeContext  context,
ComputeMemoryFlags  flags,
int  textureTarget,
int  mipLevel,
int  textureId 
) [static]

Creates a new ComputeImage3D from an OpenGL 3D texture object.

Parameters:
context A ComputeContext with enabled CL/GL sharing.
flags A bit-field that is used to specify usage information about the ComputeImage3D. Only ComputeMemoryFlags.ReadOnly, ComputeMemoryFlags.WriteOnly and ComputeMemoryFlags.ReadWrite are allowed.
textureTarget The image type of texture. Must be GL_TEXTURE_3D.
mipLevel The mipmap level of the OpenGL 2D texture object to be used.
textureId The OpenGL 2D texture object id to use.
Returns:
The created ComputeImage2D.
static ICollection<ComputeImageFormat> Cloo.ComputeImage3D.GetSupportedFormats ( ComputeContext  context,
ComputeMemoryFlags  flags 
) [static]

Gets a collection of supported ComputeImage3D ComputeImageFormats in a ComputeContext.

Parameters:
context The ComputeContext for which the collection of ComputeImageFormats is queried.
flags The ComputeMemoryFlags for which the collection of ComputeImageFormats is queried.
Returns:
The collection of the required ComputeImageFormats.

The documentation for this class was generated from the following file: