Equalizer  1.6.1
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
eq::fabric::SubPixel Class Reference

Holds a subpixel decomposition specification along with some methods for manipulation. More...

#include <subPixel.h>

+ Collaboration diagram for eq::fabric::SubPixel:

Public Member Functions

void apply (const SubPixel &rhs)
 Apply (accumulate) another subpixel specification.
 
bool operator== (const SubPixel &rhs) const
 
bool operator!= (const SubPixel &rhs) const
 
void invalidate ()
 Make the subpixel specification invalid.
 
void validate ()
 Make the subpixel specification valid.
 
bool isValid () const
 
Constructors
 SubPixel ()
 Construct an empty subpixel specification. More...
 
 SubPixel (const uint32_t index_, const uint32_t size_)
 Construct a subpixel specification with default values. More...
 

Public Attributes

uint32_t index
 The contributor id.
 
uint32_t size
 Total number of contributors.
 

Static Public Attributes

static const SubPixel ALL
 

Detailed Description

Holds a subpixel decomposition specification along with some methods for manipulation.

The index represents the contributor ID within the subpixel decomposition. The size determines how many contributors are performing anti-aliasing or any other subpixel decomposition.

Definition at line 41 of file subPixel.h.

Constructor & Destructor Documentation

eq::fabric::SubPixel::SubPixel ( )
inline

Construct an empty subpixel specification.

Version
1.0

Definition at line 47 of file subPixel.h.

eq::fabric::SubPixel::SubPixel ( const uint32_t  index_,
const uint32_t  size_ 
)
inline

Construct a subpixel specification with default values.

Version
1.0

Definition at line 53 of file subPixel.h.

Member Function Documentation

bool eq::fabric::SubPixel::isValid ( ) const
inline
Returns
true if the pixel specification is valid.

Definition at line 99 of file subPixel.h.

Referenced by apply(), and validate().

+ Here is the caller graph for this function:

bool eq::fabric::SubPixel::operator!= ( const SubPixel rhs) const
inline
Returns
true if the two subpixel specifications are not identical.
Version
1.0

Definition at line 80 of file subPixel.h.

References index, and size.

bool eq::fabric::SubPixel::operator== ( const SubPixel rhs) const
inline
Returns
true if the two subpixel specifications are identical.
Version
1.0

Definition at line 71 of file subPixel.h.

References index, and size.


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