Grok 20.3.2
Public Member Functions | Protected Attributes | List of all members
grk::Buffer< T, A > Struct Template Reference

#include <buffer.h>

Inheritance diagram for grk::Buffer< T, A >:
grk::Buffer2d< T, AllocatorAligned > grk::Buffer2d< int32_t, AllocatorAligned > grk::Buffer2d< T, A >

Public Member Functions

 Buffer (T *buffer, size_t off, size_t length, bool ownsData)
 Buffer (T *buffer, size_t length)
 Buffer ()
 Buffer (T *buffer, size_t length, bool ownsData)
virtual ~Buffer ()
 Buffer (const Buffer &rhs)
Buffer & operator= (const Buffer &rhs)
Buffer & operator= (const Buffer *rhs)
bool canRead (void)
T read (void)
bool write (T val)
bool write (T *b, size_t size)
virtual bool alloc (size_t length)
virtual void dealloc ()
void attach (T *buffer)
void transfer (T **buffer)
size_t remainingLength (void) const
bool increment_offset (std::ptrdiff_t off)
T * currPtr (void) const
T * currPtr (size_t required_length) const
bool owns_data ()
void set_owns_data (bool owns)
size_t num_elts () const
size_t * num_elts_ptr ()
void set_num_elts (size_t elts)
size_t offset () const
void set_offset (size_t off)
T * buf () const
T ** ptr_to_buf ()
void set_buf (T *buf, size_t elts)

Protected Attributes

T * buf_
size_t offset_
size_t num_elts_
bool owns_data_

Constructor & Destructor Documentation

◆ Buffer() [1/5]

template<typename T, template< typename TT > typename A>
grk::Buffer< T, A >::Buffer ( T * buffer,
size_t off,
size_t length,
bool ownsData )
inline

Referenced by grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), and grk::Buffer2d< T, AllocatorAligned >::Buffer2d().

◆ Buffer() [2/5]

template<typename T, template< typename TT > typename A>
grk::Buffer< T, A >::Buffer ( T * buffer,
size_t length )
inline

◆ Buffer() [3/5]

template<typename T, template< typename TT > typename A>
grk::Buffer< T, A >::Buffer ( )
inline

◆ Buffer() [4/5]

template<typename T, template< typename TT > typename A>
grk::Buffer< T, A >::Buffer ( T * buffer,
size_t length,
bool ownsData )
inline

◆ ~Buffer()

template<typename T, template< typename TT > typename A>
virtual grk::Buffer< T, A >::~Buffer ( )
inlinevirtual

◆ Buffer() [5/5]

template<typename T, template< typename TT > typename A>
grk::Buffer< T, A >::Buffer ( const Buffer< T, A > & rhs)
inlineexplicit

Member Function Documentation

◆ alloc()

template<typename T, template< typename TT > typename A>
virtual bool grk::Buffer< T, A >::alloc ( size_t length)
inlinevirtual

Referenced by grk::Buffer2d< T, AllocatorAligned >::alloc2d().

◆ attach()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::attach ( T * buffer)
inline

Referenced by grk::Buffer2d< T, AllocatorAligned >::attach().

◆ buf()

template<typename T, template< typename TT > typename A>
T * grk::Buffer< T, A >::buf ( ) const
inline

Referenced by grk::FileFormatJP2Compress::calcAsocSize(), grk::Buffer2d< T, AllocatorAligned >::getStride(), grk::FileFormatJP2Family::serializeAsoc(), grk::FileFormatJP2Family::write_buffer(), and grk::FileFormatJP2Compress::writeAsocBox().

◆ canRead()

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::canRead ( void )
inline

◆ currPtr() [1/2]

template<typename T, template< typename TT > typename A>
T * grk::Buffer< T, A >::currPtr ( size_t required_length) const
inline

◆ currPtr() [2/2]

template<typename T, template< typename TT > typename A>
T * grk::Buffer< T, A >::currPtr ( void ) const
inline

Referenced by grk::Buffer2d< T, AllocatorAligned >::address(), grk::Buffer< uint8_t, AllocatorVanilla >::currPtr(), and grk::Buffer2d< T, AllocatorAligned >::getBuffer().

◆ dealloc()

template<typename T, template< typename TT > typename A>
virtual void grk::Buffer< T, A >::dealloc ( )
inlinevirtual

Reimplemented in grk::AsocBox, grk::Buffer2d< T, A >, grk::Buffer2d< int32_t, AllocatorAligned >, and grk::Buffer2d< T, AllocatorAligned >.

Referenced by grk::Buffer< uint8_t, AllocatorVanilla >::alloc(), grk::Buffer2d< T, AllocatorAligned >::attach(), grk::Buffer< uint8_t, AllocatorVanilla >::attach(), grk::Buffer2d< T, AllocatorAligned >::dealloc(), and grk::Buffer< uint8_t, AllocatorVanilla >::~Buffer().

◆ increment_offset()

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::increment_offset ( std::ptrdiff_t off)
inline

◆ num_elts()

template<typename T, template< typename TT > typename A>
size_t grk::Buffer< T, A >::num_elts ( ) const
inline

Referenced by grk::Buffer2d< T, AllocatorAligned >::alloc2d(), grk::Buffer2d< T, AllocatorAligned >::attach(), grk::FileFormatJP2Compress::calcAsocSize(), grk::Buffer2d< T, AllocatorAligned >::length(), grk::Buffer< uint8_t, AllocatorVanilla >::operator=(), grk::FileFormatJP2Family::serializeAsoc(), grk::FileFormatJP2Family::write_buffer(), and grk::FileFormatJP2Compress::writeAsocBox().

◆ num_elts_ptr()

template<typename T, template< typename TT > typename A>
size_t * grk::Buffer< T, A >::num_elts_ptr ( )
inline

◆ offset()

template<typename T, template< typename TT > typename A>
size_t grk::Buffer< T, A >::offset ( ) const
inline

Referenced by grk::Buffer< uint8_t, AllocatorVanilla >::operator=().

◆ operator=() [1/2]

template<typename T, template< typename TT > typename A>
Buffer & grk::Buffer< T, A >::operator= ( const Buffer< T, A > & rhs)
inline

Referenced by grk::Buffer< uint8_t, AllocatorVanilla >::Buffer(), grk::Buffer2d< T, AllocatorAligned >::operator=(), and grk::Buffer< uint8_t, AllocatorVanilla >::operator=().

◆ operator=() [2/2]

template<typename T, template< typename TT > typename A>
Buffer & grk::Buffer< T, A >::operator= ( const Buffer< T, A > * rhs)
inline

◆ owns_data()

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::owns_data ( )
inline

◆ ptr_to_buf()

template<typename T, template< typename TT > typename A>
T ** grk::Buffer< T, A >::ptr_to_buf ( )
inline

◆ read()

template<typename T, template< typename TT > typename A>
T grk::Buffer< T, A >::read ( void )
inline

◆ remainingLength()

template<typename T, template< typename TT > typename A>
size_t grk::Buffer< T, A >::remainingLength ( void ) const
inline

◆ set_buf()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::set_buf ( T * buf,
size_t elts )
inline

◆ set_num_elts()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::set_num_elts ( size_t elts)
inline

Referenced by grk::compress_synch_with_plugin().

◆ set_offset()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::set_offset ( size_t off)
inline

◆ set_owns_data()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::set_owns_data ( bool owns)
inline

◆ transfer()

template<typename T, template< typename TT > typename A>
void grk::Buffer< T, A >::transfer ( T ** buffer)
inline

Referenced by grk::Buffer2d< T, AllocatorAligned >::transfer().

◆ write() [1/2]

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::write ( T * b,
size_t size )
inline

◆ write() [2/2]

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::write ( T val)
inline

Member Data Documentation

◆ buf_

template<typename T, template< typename TT > typename A>
T* grk::Buffer< T, A >::buf_
protected

Referenced by grk::Buffer2d< T, AllocatorAligned >::attach(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::Buffer2d(), grk::Buffer2d< T, AllocatorAligned >::clear(), grk::Buffer2d< T, AllocatorAligned >::copyFrom(), grk::Buffer2d< T, AllocatorAligned >::copyFromNarrow(), grk::Buffer2d< T, AllocatorAligned >::operator=(), grk::Buffer< uint8_t, AllocatorVanilla >::operator=(), grk::Buffer2d< T, AllocatorAligned >::simple(), and grk::Buffer2d< T, AllocatorAligned >::simpleF().

◆ num_elts_

template<typename T, template< typename TT > typename A>
size_t grk::Buffer< T, A >::num_elts_
protected

Referenced by grk::Buffer2d< T, AllocatorAligned >::attach().

◆ offset_

template<typename T, template< typename TT > typename A>
size_t grk::Buffer< T, A >::offset_
protected

◆ owns_data_

template<typename T, template< typename TT > typename A>
bool grk::Buffer< T, A >::owns_data_
protected

Referenced by grk::Buffer2d< T, AllocatorAligned >::attach().

The documentation for this struct was generated from the following file:
Generated by doxygen 1.17.0