From 3dfe2108cfab31ba3ee5527e217d0d8e99a51162 Mon Sep 17 00:00:00 2001 From: git perforce import user Date: Tue, 25 Oct 2016 12:29:14 -0600 Subject: Initial commit: PhysX 3.4.0 Update @ 21294896 APEX 1.4.0 Update @ 21275617 [CL 21300167] --- .../PhysXAPI/files/classPxFileBuf.html | 1004 ++++++++++++++++++++ 1 file changed, 1004 insertions(+) create mode 100644 PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html (limited to 'PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html') diff --git a/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html new file mode 100644 index 00000000..cb051301 --- /dev/null +++ b/PhysX_3.4/Documentation/PhysXAPI/files/classPxFileBuf.html @@ -0,0 +1,1004 @@ + + + NVIDIA(R) PhysX(R) SDK 3.4 API Reference: PxFileBuf Class Reference + + + + + + + +
+

PxFileBuf Class Reference
+ +[Foundation] +

Callback class for data serialization. +More... +

+#include <PxFileBuf.h> +

+ +

+List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  EndianMode {
+  ENDIAN_NONE = 0, +
+  ENDIAN_BIG = 1, +
+  ENDIAN_LITTLE = 2 +
+ }
enum  OpenMode {
+  OPEN_FILE_NOT_FOUND, +
+  OPEN_READ_ONLY, +
+  OPEN_WRITE_ONLY, +
+  OPEN_READ_WRITE_NEW, +
+  OPEN_READ_WRITE_EXISTING +
+ }
enum  SeekType {
+  SEEKABLE_NO = 0, +
+  SEEKABLE_READ = 0x1, +
+  SEEKABLE_WRITE = 0x2, +
+  SEEKABLE_READWRITE = 0x3 +
+ }

Public Member Functions

 PxFileBuf (EndianMode mode=ENDIAN_LITTLE)
virtual ~PxFileBuf (void)
virtual OpenMode getOpenMode (void) const =0
bool isOpen (void) const
virtual SeekType isSeekable (void) const =0
void setEndianMode (EndianMode e)
EndianMode getEndianMode (void) const
virtual uint32_t getFileLength (void) const =0
virtual uint32_t seekRead (uint32_t loc)=0
 Seeks the stream to a particular location for reading.
virtual uint32_t seekWrite (uint32_t loc)=0
 Seeks the stream to a particular location for writing.
virtual uint32_t read (void *mem, uint32_t len)=0
 Reads from the stream into a buffer.
virtual uint32_t peek (void *mem, uint32_t len)=0
 Reads from the stream into a buffer but does not advance the read location.
virtual uint32_t write (const void *mem, uint32_t len)=0
 Writes a buffer of memory to the stream.
virtual uint32_t tellRead (void) const =0
 Reports the current stream location read aqccess.
virtual uint32_t tellWrite (void) const =0
 Reports the current stream location for write access.
virtual void flush (void)=0
 Causes any temporarily cached data to be flushed to the stream.
virtual void close (void)
 Close the stream.
void release (void)
PX_INLINE void swap2Bytes (void *_data) const
PX_INLINE void swap4Bytes (void *_data) const
PX_INLINE void swap8Bytes (void *_data) const
PX_INLINE void storeDword (uint32_t v)
PX_INLINE void storeFloat (float v)
PX_INLINE void storeDouble (double v)
PX_INLINE void storeByte (uint8_t b)
PX_INLINE void storeWord (uint16_t w)
uint8_t readByte (void)
uint16_t readWord (void)
uint32_t readDword (void)
float readFloat (void)
double readDouble (void)

Static Public Member Functions

static PX_INLINE bool isBigEndian ()

Static Public Attributes

static const uint32_t STREAM_SEEK_END = 0xFFFFFFFF
 Declares a constant to seek to the end of the stream.

Private Attributes

bool mEndianSwap
EndianMode mEndianMode
+

Detailed Description

+Callback class for data serialization. +

+The user needs to supply an PxFileBuf implementation to a number of methods to allow the SDK to read or write chunks of binary data. This allows flexibility for the source/destination of the data. For example the PxFileBuf could store data in a file, memory buffer or custom file format.

+

Note:
It is the users responsibility to ensure that the data is written to the appropriate offset.
+

Member Enumeration Documentation

+ +
+
+ + + + +
enum PxFileBuf::EndianMode
+
+
+ +

+

Enumerator:
+ + + + +
ENDIAN_NONE  +
ENDIAN_BIG  +
ENDIAN_LITTLE  +
+
+ +
+

+ +

+
+ + + + +
enum PxFileBuf::OpenMode
+
+
+ +

+

Enumerator:
+ + + + + + +
OPEN_FILE_NOT_FOUND  +
OPEN_READ_ONLY  +
OPEN_WRITE_ONLY  +
OPEN_READ_WRITE_NEW  +
OPEN_READ_WRITE_EXISTING  +
+
+ +
+

+ +

+
+ + + + +
enum PxFileBuf::SeekType
+
+
+ +

+

Enumerator:
+ + + + + +
SEEKABLE_NO  +
SEEKABLE_READ  +
SEEKABLE_WRITE  +
SEEKABLE_READWRITE  +
+
+ +
+

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + +
PxFileBuf::PxFileBuf (EndianMode  mode = ENDIAN_LITTLE  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual PxFileBuf::~PxFileBuf (void   )  [inline, virtual]
+
+
+ +

+ +

+

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
virtual void PxFileBuf::close (void   )  [inline, virtual]
+
+
+ +

+Close the stream. +

+ +

+

+ +

+
+ + + + + + + + + +
virtual void PxFileBuf::flush (void   )  [pure virtual]
+
+
+ +

+Causes any temporarily cached data to be flushed to the stream. +

+ +

+

+ +

+
+ + + + + + + + + +
EndianMode PxFileBuf::getEndianMode (void   )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual uint32_t PxFileBuf::getFileLength (void   )  const [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual OpenMode PxFileBuf::getOpenMode (void   )  const [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + +
static PX_INLINE bool PxFileBuf::isBigEndian (  )  [inline, static]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
bool PxFileBuf::isOpen (void   )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual SeekType PxFileBuf::isSeekable (void   )  const [pure virtual]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual uint32_t PxFileBuf::peek (void *  mem,
uint32_t  len 
) [pure virtual]
+
+
+ +

+Reads from the stream into a buffer but does not advance the read location. +

+

Parameters:
+ + + +
[out] mem The buffer to read the stream into.
[in] len The number of bytes to stream into the buffer
+
+
Returns:
Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual uint32_t PxFileBuf::read (void *  mem,
uint32_t  len 
) [pure virtual]
+
+
+ +

+Reads from the stream into a buffer. +

+

Parameters:
+ + + +
[out] mem The buffer to read the stream into.
[in] len The number of bytes to stream into the buffer
+
+
Returns:
Returns the actual number of bytes read. If not equal to the length requested, then reached end of stream.
+ +
+

+ +

+
+ + + + + + + + + +
uint8_t PxFileBuf::readByte (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
double PxFileBuf::readDouble (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
uint32_t PxFileBuf::readDword (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
float PxFileBuf::readFloat (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
uint16_t PxFileBuf::readWord (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
void PxFileBuf::release (void   )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual uint32_t PxFileBuf::seekRead (uint32_t  loc  )  [pure virtual]
+
+
+ +

+Seeks the stream to a particular location for reading. +

+If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position +

+

+ +

+
+ + + + + + + + + +
virtual uint32_t PxFileBuf::seekWrite (uint32_t  loc  )  [pure virtual]
+
+
+ +

+Seeks the stream to a particular location for writing. +

+If the location passed exceeds the length of the stream, then it will seek to the end. Returns the location it ended up at (useful if you seek to the end) to get the file position +

+

+ +

+
+ + + + + + + + + +
void PxFileBuf::setEndianMode (EndianMode  e  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::storeByte (uint8_t  b  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::storeDouble (double  v  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::storeDword (uint32_t  v  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::storeFloat (float  v  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::storeWord (uint16_t  w  )  [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::swap2Bytes (void *  _data  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::swap4Bytes (void *  _data  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
PX_INLINE void PxFileBuf::swap8Bytes (void *  _data  )  const [inline]
+
+
+ +

+ +

+

+ +

+
+ + + + + + + + + +
virtual uint32_t PxFileBuf::tellRead (void   )  const [pure virtual]
+
+
+ +

+Reports the current stream location read aqccess. +

+

Returns:
Returns the current stream read location.
+ +
+

+ +

+
+ + + + + + + + + +
virtual uint32_t PxFileBuf::tellWrite (void   )  const [pure virtual]
+
+
+ +

+Reports the current stream location for write access. +

+

Returns:
Returns the current stream write location.
+ +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
virtual uint32_t PxFileBuf::write (const void *  mem,
uint32_t  len 
) [pure virtual]
+
+
+ +

+Writes a buffer of memory to the stream. +

+

Parameters:
+ + + +
[in] mem The address of a buffer of memory to send to the stream.
[in] len The number of bytes to send to the stream.
+
+
Returns:
Returns the actual number of bytes sent to the stream. If not equal to the length specific, then the stream is full or unable to write for some reason.
+ +
+

+

Member Data Documentation

+ +
+
+ + + + +
EndianMode PxFileBuf::mEndianMode [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
bool PxFileBuf::mEndianSwap [private]
+
+
+ +

+ +

+

+ +

+
+ + + + +
const uint32_t PxFileBuf::STREAM_SEEK_END = 0xFFFFFFFF [static]
+
+
+ +

+Declares a constant to seek to the end of the stream. +

+Does not support streams longer than 32 bits +

+

+

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

+Copyright © 2008-2016 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com + + -- cgit v1.2.3