Public Types | Public Member Functions
cinder::SurfaceChannelOrder Class Reference

Specifies the in-memory ordering of the channels of a Surface. More...

#include <Surface.h>

List of all members.

Public Types

enum  {
  CHAN_RED, CHAN_GREEN, CHAN_BLUE, CHAN_ALPHA,
  INVALID = 255
}
enum  {
  RGBA, BGRA, ARGB, ABGR,
  RGBX, BGRX, XRGB, XBGR,
  RGB, BGR, UNSPECIFIED
}

Public Member Functions

 SurfaceChannelOrder ()
 SurfaceChannelOrder (int aCode)
 SurfaceChannelOrder (const SurfaceChannelOrder &aOrder)
uint8_t getRedOffset () const
uint8_t getGreenOffset () const
uint8_t getBlueOffset () const
uint8_t getAlphaOffset () const
bool hasAlpha () const
uint8_t getPixelInc () const
int getCode () const
bool operator== (const SurfaceChannelOrder &sco) const
int getImageIoChannelOrder () const
 Translates a SurfaceChannelOrder into an ImageIo::ChannelOrder.

Detailed Description

Specifies the in-memory ordering of the channels of a Surface.


Member Enumeration Documentation

anonymous enum
Enumerator:
CHAN_RED 
CHAN_GREEN 
CHAN_BLUE 
CHAN_ALPHA 
INVALID 
anonymous enum
Enumerator:
RGBA 
BGRA 
ARGB 
ABGR 
RGBX 
BGRX 
XRGB 
XBGR 
RGB 
BGR 
UNSPECIFIED 

Constructor & Destructor Documentation


Member Function Documentation

bool cinder::SurfaceChannelOrder::operator== ( const SurfaceChannelOrder sco) const

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