Reference Page for vsFieldPacking

OpenGL Vizserver Reference Page

NAME

vsFieldPacking - Definition of field image contents

INHERITS FROM

vsParamTypeCls : vsCmprParamTypeCls

HEADER FILE

#include <vizserver/vsFrame.h>

PUBLIC METHOD SUMMARY

Creating and destroying

vsFieldPacking (

vsBool topdown, vsInt padding);

virtual ~vsFieldPacking (

);

virtual vsBool getTopdown (

) const;

virtual int getPadding (

) const;

vsBool isParamTypeSupported (

vsParamTypes::Base) const;

inline vsCmprParamTypesFieldParams getParamName (

) const;

INHERITED PUBLIC METHODS

Inherited from vsCmprParamTypeCls

virtual ParamGroup getParamName (

) const;

Inherited from vsParamTypeCls

virtual vsBool isParamTypeSupported (

vsParamTypes::Base name) const;

CLASS DESCRIPTION

Images rendered by an application and transported to the client system are captured in frames. A frame consists of multiple fields, each field having a specific type. There are two basic field types: color and depth. Within each type, there are several subtypes for the left and right eyes for stereo rendered images. Frames are represented by vsFramePacking and vsFrameInfo objects.

vsFieldPacking is also a vsParamTypeCls and can be extracted from various query container types. This object represents a buffer of field image data, in other words, the actual pixel data for an image field.

The field data can be processed with an associated vsFieldInfo object that is always bundled along with the field data within a vsFrameInfo structure. This information packet can be used to parse the image data for compression and decompression.

METHOD DESCRIPTIONS

vsFieldPacking()

vsFieldPacking (

vsBool topdown, vsInt padding);

Constructs a new vsFieldPacking object. topdown is the top-down orientation of the image's lines. padding is the number of pixels contained in each line, including the ones that are actually part of the image's width.

~vsFieldPacking()

virtual ~vsFieldPacking (

);

Destroys the field structure.

getPadding()

virtual int getPadding (

) const;

Returns the padding value of each line of the field data

getParamName()

inline vsCmprParamTypesFieldParams getParamName (

) const;

Returns the specific parameter name associated with this parameter. vsFieldPacking can return two different parameter names: vsCmprParamTypes::FieldPacking in circumstances where it is contained within a vsFramePacking object and vsCmprParamTypes::FieldPackingParam in circumstances where it is contained within the more generic vsCmprParamArg object.

getTopdown()

virtual vsBool getTopdown (

) const;

Returns the top-down orientation of the field data

isParamTypeSupported()

vsBool isParamTypeSupported (

vsParamTypes::Base) const;

Returns TRUE if this object belongs to the parameter type family specified by vsParamTypes::Base argument. vsFieldPacking initially belongs to the vsParamTypes::CmprParam family.