Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

NBFHeader Struct Reference

The NBFHeader structure represents the NBF header format. More...

#include <NBF.h>

List of all members.

Public Member Functions

 PADDING (2)
 Padding bits to ensure offset of scene is on a 4-byte boundary, regardless of packing.

Public Attributes

byte_t signature [4]
 A 4-byte signature identifying the file as a valid NBF file. The bytes are "#NBF".
ubyte_t nbfMajorVersion
 Specifies the major part of the NBF version used to save the file.
ubyte_t nbfMinorVersion
 Specifies the minor part (compatibility level) of the NBF version used to save the file.
ubyte_t nbfBugfixLevel
ubyte_t nvsgMajorVersion
 Specifies the major part of the NVSG version the content of this file is compatible to.
ubyte_t nvsgMinorVersion
 Specifies the minor part of the NVSG version the content of this file is compatible to.
ubyte_t nvsgBugfixLevel
ubyte_t reserved [16]
 Reserved bytes for future extensions.
ubyte_t dayLastModified
 Specifies the day (1-31) of last modification.
ubyte_t monthLastModified
 Specifies the month (1-12) of last modification.
ubyte_t yearLastModified [2]
 Specifies the year of last modification.
ubyte_t secondLastModified
 Specifies the second (0-59) of last modification.
ubyte_t minuteLastModified
 Specifies the minute (0-59) of last modification.
ubyte_t hourLastModified
 Specifies the hour (0-23) of last modification.
ubyte_t byteOrder
uint_t scene
 Specifies the file offset to the contained NBFScene object.
uint_t viewState


Detailed Description

The NBFHeader structure represents the NBF header format.

The NBFHeader structure is the primary location where NBF specifics are stored.
For a valid NBF file, the NBFHeader structure is stored at file offset 0. Note that, except for the NBFHeader object, a file offset of 0 indicates an invalid file offset!
This structure mainly serves as validation and compatibility checks for verification purposes. It also maintains the file offset to the contained NBFScene object, which represents a scene in the context of computer graphics.


Member Function Documentation

NBFHeader::PADDING  ) 
 

Padding bits to ensure offset of scene is on a 4-byte boundary, regardless of packing.


Member Data Documentation

byte_t NBFHeader::signature[4]
 

A 4-byte signature identifying the file as a valid NBF file. The bytes are "#NBF".

ubyte_t NBFHeader::nbfMajorVersion
 

Specifies the major part of the NBF version used to save the file.

ubyte_t NBFHeader::nbfMinorVersion
 

Specifies the minor part (compatibility level) of the NBF version used to save the file.

ubyte_t NBFHeader::nbfBugfixLevel
 

Specifies the bugfix level of the NBF version used to save the file. This is optional information, as a bugfix level does not influence compatibility issues, and hence must not be taken into account for compatibility checks.

ubyte_t NBFHeader::nvsgMajorVersion
 

Specifies the major part of the NVSG version the content of this file is compatible to.

ubyte_t NBFHeader::nvsgMinorVersion
 

Specifies the minor part of the NVSG version the content of this file is compatible to.

ubyte_t NBFHeader::nvsgBugfixLevel
 

Specifies the bugfix level of the NVSG version. This is optional information, as a bugfix level does not influence compatibility issues, and hence must not be taken into account for compatibility checks.

ubyte_t NBFHeader::reserved[16]
 

Reserved bytes for future extensions.

ubyte_t NBFHeader::dayLastModified
 

Specifies the day (1-31) of last modification.

ubyte_t NBFHeader::monthLastModified
 

Specifies the month (1-12) of last modification.

ubyte_t NBFHeader::yearLastModified[2]
 

Specifies the year of last modification.

ubyte_t NBFHeader::secondLastModified
 

Specifies the second (0-59) of last modification.

ubyte_t NBFHeader::minuteLastModified
 

Specifies the minute (0-59) of last modification.

ubyte_t NBFHeader::hourLastModified
 

Specifies the hour (0-23) of last modification.

ubyte_t NBFHeader::byteOrder
 

Specifies the byte order used to save the contained data. A value of 0 implies little-endian byte order, a value of 1 implies big-endian byte order. It is more convenient to use the symbolic constants NBF_LITTLE_ENDIAN and NBF_BIG_ENDIAN here.

uint_t NBFHeader::scene
 

Specifies the file offset to the contained NBFScene object.

uint_t NBFHeader::viewState
 

Specifies the file offset to an optional NBFViewState object. An offset of 0 indicates that no NBFViewState object is available in this file.


The documentation for this struct was generated from the following file:
Generated on Tue Mar 1 13:20:26 2005 for NVSGSDK by NVIDIA