OpenGL Vizserver Reference Page


NAME
vsFieldData - Definition of field image contents

INHERITS FROM
vsParamTypeCls : vsCmprParamTypeCls

HEADER FILE
#include <vizserver/vsFrame.h>

PUBLIC METHOD SUMMARY
virtual ~vsFieldData (  );
virtual vsStatus getData ( void*&) const = 0;
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 vsFrameData and vsFrameInfo objects.

vsFieldData 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

   ~vsFieldData()
virtual ~vsFieldData (  );

Destroys the field data structure.

   getData()
virtual vsStatus getData ( void*&) const = 0;

Copies a pointer to the field image data to the supplied argument. The client that uses the image data must process it with the associated vsFieldInfo structure for this field.

   getParamName()
inline vsCmprParamTypesFieldParams getParamName (  ) const;

Returns the specific parameter name associated with this parameter. vsFieldData can return two different parameter names: vsCmprParamTypes::FieldData in circumstances where it is contained within a vsFrameData object and vsCmprParamTypes::FieldDataParam in circumstances where it is contained within the more generic vsCmprParamArg object.

   isParamTypeSupported()
vsBool isParamTypeSupported ( vsParamTypes::Base) const;

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

SEE ALSO
vsCmprParamTypeCls, vsFieldInfo, vsFrameData, vsFrameInfo, vsParamTypeCls