go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Public Types | Public Member Functions | Private Attributes | Friends
itk::OpenCLImageFormat Class Reference

#include <itkOpenCLImageFormat.h>

Detailed Description

The OpenCLImageFormat class represents the format of a OpenCLImage.

Definition at line 34 of file itkOpenCLImageFormat.h.

Public Types

enum  ChannelOrder {
  R = 0x10B0, A = 0x10B1, RG = 0x10B2, RA = 0x10B3,
  RGB = 0x10B4, RGBA = 0x10B5, BGRA = 0x10B6, ARGB = 0x10B7,
  INTENSITY = 0x10B8, LUMINANCE = 0x10B9, Rx = 0x10BA, RGx = 0x10BB,
  RGBx = 0x10BC, DEPTH = 0x10BD, DEPTH_STENCIL = 0x10BE
}
 
enum  ChannelType {
  SNORM_INT8 = 0x10D0, SNORM_INT16 = 0x10D1, UNORM_INT8 = 0x10D2, UNORM_INT16 = 0x10D3,
  UNORM_SHORT_565 = 0x10D4, UNORM_SHORT_555 = 0x10D5, UNORM_INT_101010 = 0x10D6, SIGNED_INT8 = 0x10D7,
  SIGNED_INT16 = 0x10D8, SIGNED_INT32 = 0x10D9, UNSIGNED_INT8 = 0x10DA, UNSIGNED_INT16 = 0x10DB,
  UNSIGNED_INT32 = 0x10DC, HALF_FLOAT = 0x10DD, FLOAT = 0x10DE, UNORM_INT24 = 0x10DF
}
 
enum  ImageType {
  BUFFER = 0x10F0, IMAGE2D = 0x10F1, IMAGE3D = 0x10F2, IMAGE2D_ARRAY = 0x10F3,
  IMAGE1D = 0x10F4, IMAGE1D_ARRAY = 0x10F5, IMAGE1D_BUFFER = 0x10F6
}
 
typedef OpenCLImageFormat Self
 

Public Member Functions

OpenCLImageFormat::ChannelOrder GetChannelOrder () const
 
OpenCLImageFormat::ChannelType GetChannelType () const
 
OpenCLImageFormat::ImageType GetImageType () const
 
bool IsNull () const
 
 OpenCLImageFormat ()
 
 OpenCLImageFormat (const OpenCLImageFormat::ChannelOrder channelOrder, const OpenCLImageFormat::ChannelType channelType)
 
 OpenCLImageFormat (const OpenCLImageFormat::ImageType imageType, const OpenCLImageFormat::ChannelOrder channelOrder, const OpenCLImageFormat::ChannelType channelType)
 

Private Attributes

cl_image_format m_Format
 
cl_mem_object_type m_ImageType
 

Friends

class OpenCLContext
 
class OpenCLImage
 

Member Typedef Documentation

Standard class typedefs.

Definition at line 39 of file itkOpenCLImageFormat.h.

Member Enumeration Documentation

Enumerator
RG 
RA 
RGB 
RGBA 
BGRA 
ARGB 
INTENSITY 
LUMINANCE 
Rx 
RGx 
RGBx 
DEPTH 
DEPTH_STENCIL 

Definition at line 90 of file itkOpenCLImageFormat.h.

Enumerator
SNORM_INT8 
SNORM_INT16 
UNORM_INT8 
UNORM_INT16 
UNORM_SHORT_565 
UNORM_SHORT_555 
UNORM_INT_101010 
SIGNED_INT8 
SIGNED_INT16 
SIGNED_INT32 
UNSIGNED_INT8 
UNSIGNED_INT16 
UNSIGNED_INT32 
HALF_FLOAT 
FLOAT 
UNORM_INT24 

Definition at line 133 of file itkOpenCLImageFormat.h.

Enumerator
BUFFER 
IMAGE2D 
IMAGE3D 
IMAGE2D_ARRAY 
IMAGE1D 
IMAGE1D_ARRAY 
IMAGE1D_BUFFER 

Definition at line 50 of file itkOpenCLImageFormat.h.

Constructor & Destructor Documentation

itk::OpenCLImageFormat::OpenCLImageFormat ( )

Constructs a null OpenCL image format descriptor.

See also
IsNull()
itk::OpenCLImageFormat::OpenCLImageFormat ( const OpenCLImageFormat::ChannelOrder  channelOrder,
const OpenCLImageFormat::ChannelType  channelType 
)

Constructs an OpenCL image format descriptor from channelOrder and channelType.

itk::OpenCLImageFormat::OpenCLImageFormat ( const OpenCLImageFormat::ImageType  imageType,
const OpenCLImageFormat::ChannelOrder  channelOrder,
const OpenCLImageFormat::ChannelType  channelType 
)

Constructs an OpenCL image format descriptor from imageType channelOrder and channelType.

Member Function Documentation

OpenCLImageFormat::ChannelOrder itk::OpenCLImageFormat::GetChannelOrder ( ) const

Returns the order of channels in this OpenCL image format.

See also
GetChannelType(), GetImageType()
OpenCLImageFormat::ChannelType itk::OpenCLImageFormat::GetChannelType ( ) const

Returns the representation type for channels in this OpenCL image format.

See also
GetChannelOrder(), GetImageType()
OpenCLImageFormat::ImageType itk::OpenCLImageFormat::GetImageType ( ) const

Returns the image type in this OpenCL image format.

See also
GetChannelOrder(), GetChannelType()
bool itk::OpenCLImageFormat::IsNull ( ) const

Returns true if this OpenCL image format descriptor is null.

Friends And Related Function Documentation

friend class OpenCLContext
friend

friends from OpenCL core

Definition at line 190 of file itkOpenCLImageFormat.h.

friend class OpenCLImage
friend

Definition at line 191 of file itkOpenCLImageFormat.h.

Field Documentation

cl_image_format itk::OpenCLImageFormat::m_Format
private

Definition at line 187 of file itkOpenCLImageFormat.h.

cl_mem_object_type itk::OpenCLImageFormat::m_ImageType
private

Definition at line 186 of file itkOpenCLImageFormat.h.



Generated on 04-09-2015 for elastix by doxygen 1.8.9.1 elastix logo