Equalizer  1.7.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
eq::PixelData Struct Reference

The pixel data structure manages the pixel information for images. More...

#include <pixelData.h>

+ Inheritance diagram for eq::PixelData:
+ Collaboration diagram for eq::PixelData:

Public Member Functions

EQ_API PixelData ()
 Construct new pixel data. More...
 
EQ_API ~PixelData ()
 Destruct the pixel data. More...
 
void reset ()
 Reset the data. More...
 

Public Attributes

uint32_t internalFormat
 The type of data stored in FrameBuffer or texture on the GPU. More...
 
uint32_t externalFormat
 The type of data stored in pixels in main memory. More...
 
uint32_t pixelSize
 The size of one pixel, in bytes, stored in pixels. More...
 
PixelViewport pvp
 The dimensions of the pixel data in pixels. More...
 
void * pixels
 uncompressed pixel data, pvp * pixelSize bytes. More...
 
lunchbox::CompressorResult compressedData
 The compressed pixel data blocks. More...
 
uint32_t compressorName
 The compressor used to produce compressedData. More...
 
uint32_t compressorFlags
 Flags used for compression. More...
 

Detailed Description

The pixel data structure manages the pixel information for images.

Definition at line 33 of file pixelData.h.

Constructor & Destructor Documentation

EQ_API eq::PixelData::PixelData ( )

Construct new pixel data.

Version
1.0
EQ_API eq::PixelData::~PixelData ( )

Destruct the pixel data.

Version
1.0

Member Function Documentation

void eq::PixelData::reset ( )

Reset the data.

This will not free the data pointed to by pixels and compressedPixels.

Version
1.0

Member Data Documentation

lunchbox::CompressorResult eq::PixelData::compressedData

The compressed pixel data blocks.

Version
1.9.1

Definition at line 88 of file pixelData.h.

uint32_t eq::PixelData::compressorFlags

Flags used for compression.

Version
1.0

Definition at line 93 of file pixelData.h.

uint32_t eq::PixelData::compressorName

The compressor used to produce compressedData.

Version
1.0

Definition at line 91 of file pixelData.h.

uint32_t eq::PixelData::externalFormat

The type of data stored in pixels in main memory.

See Also
the output token types in plugins/compressor.h
Version
1.0

Definition at line 62 of file pixelData.h.

uint32_t eq::PixelData::internalFormat

The type of data stored in FrameBuffer or texture on the GPU.

See Also
the input token types in plugins/compressor.h
Version
1.0

Definition at line 55 of file pixelData.h.

void* eq::PixelData::pixels

uncompressed pixel data, pvp * pixelSize bytes.

Version
1.0

Definition at line 85 of file pixelData.h.

uint32_t eq::PixelData::pixelSize

The size of one pixel, in bytes, stored in pixels.

See Also
the output token types in plugins/compressor.h
Version
1.0

Definition at line 69 of file pixelData.h.

PixelViewport eq::PixelData::pvp

The dimensions of the pixel data in pixels.

Note that this pvp might differ from the image pvp since the data is downloaded from the GPU using a plugin, which might compress the data. If unmodified pixel data is required, the correct download plugin has to be used.

See Also
Image::allocDownloader()
Version
1.0

Definition at line 82 of file pixelData.h.


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