OpenCMISS-Zinc C++ API Documentation
Public Member Functions | List of all members
OpenCMISS::Zinc::StreamresourceMemory Class Reference

A derived stream resource describing a block of memory. More...

#include <stream.hpp>

Inheritance diagram for OpenCMISS::Zinc::StreamresourceMemory:
OpenCMISS::Zinc::Streamresource

Public Member Functions

 StreamresourceMemory (cmzn_streamresource_memory_id streamresource_memory_id)
 
int getBuffer (void **memory_buffer_references, unsigned int *memory_buffer_sizes)
 
- Public Member Functions inherited from OpenCMISS::Zinc::Streamresource
 Streamresource (cmzn_streamresource_id in_streamresource_id)
 
 Streamresource (const Streamresource &streamResource)
 
Streamresourceoperator= (const Streamresource &streamResource)
 
bool isValid () const
 
cmzn_streamresource_id getId () const
 
StreamresourceFile castFile ()
 
StreamresourceMemory castMemory ()
 

Additional Inherited Members

- Protected Attributes inherited from OpenCMISS::Zinc::Streamresource
cmzn_streamresource_id id
 

Detailed Description

A derived stream resource describing a block of memory.

A derived stream resource describing a block of memory.

See also
Streaminformation::createStreamresourceMemory
Streaminformation::createStreamresourceMemory_buffer

Member Function Documentation

int OpenCMISS::Zinc::StreamresourceMemory::getBuffer ( void **  memory_buffer_references,
unsigned int *  memory_buffer_sizes 
)
inline

Return the memory block currently in the stream resource object.

See also
Region::write
FieldImage::write
Parameters
memory_buffer_referencesWill be set to point to the allocated memory block.
memory_buffer_sizesWill be set to the length of the returned memory block.
Returns
Status OpenCMISS::Zinc::OK on success, any other value on failure.

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