cocos2d-x  3.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
BundleReader Class Reference

BundleReader is an interface for reading sequence of bytes. More...

#include <CCBundleReader.h>

Inheritance diagram for BundleReader:
Ref

Public Member Functions

 BundleReader ()
 Structor. More...
 
 ~BundleReader ()
 inicial More...
 
void init (char *buffer, ssize_t length)
 initialise More...
 
ssize_t read (void *ptr, ssize_t size, ssize_t count)
 Reads an array of elements. More...
 
char * readLine (int num, char *line)
 Reads a line from the buffer. More...
 
bool eof ()
 Returns true if the end of the buffer has been reached. More...
 
ssize_t length ()
 Returns the length of the buffer in bytes. More...
 
ssize_t tell ()
 Returns the position of the file pointer. More...
 
bool seek (long int offset, int origin)
 Sets the position of the file pointer. More...
 
bool rewind ()
 Sets the file pointer at the start of the file. More...
 
template<typename T >
bool read (T *ptr)
 read binary typed value. More...
 
template<typename T >
bool readArray (unsigned int *length, std::vector< T > *values)
 template function to read array of value. More...
 
std::string readString ()
 first read length, then read string text More...
 
bool readMatrix (float *m)
 
template<>
bool read (char *ptr)
 specalization for char More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 NA NA More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 

Detailed Description

BundleReader is an interface for reading sequence of bytes.

Constructor & Destructor Documentation

Structor.

inicial

Member Function Documentation

bool eof ( )

Returns true if the end of the buffer has been reached.

void init ( char *  buffer,
ssize_t  length 
)

initialise

Parameters
lpbufferThe data buffer pointer
lengthThe data buffer size
ssize_t length ( )

Returns the length of the buffer in bytes.

ssize_t read ( void *  ptr,
ssize_t  size,
ssize_t  count 
)

Reads an array of elements.

Parameters
ptrThe pointer to the memory to copy into. The available size should be at least bytes.
sizeThe size of each element to be read, in bytes.
countThe number of elements to read.
Returns
The number of elements read.
bool read ( T *  ptr)
inline

read binary typed value.

template read routines

bool read ( char *  ptr)
inline

specalization for char

bool readArray ( unsigned int *  length,
std::vector< T > *  values 
)
inline

template function to read array of value.

char* readLine ( int  num,
char *  line 
)

Reads a line from the buffer.

bool readMatrix ( float *  m)
std::string readString ( )

first read length, then read string text

bool rewind ( )

Sets the file pointer at the start of the file.

bool seek ( long int  offset,
int  origin 
)

Sets the position of the file pointer.

ssize_t tell ( )

Returns the position of the file pointer.


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