Open CASCADE Technology  7.6.0
Public Member Functions

Image_PixMapTypedData< PixelType_t > Class Template Reference

Structure to manage image buffer with predefined pixel type. More...

#include <Image_PixMapTypedData.hxx>

Inheritance diagram for Image_PixMapTypedData< PixelType_t >:
Inheritance graph
[legend]

Public Member Functions

 Image_PixMapTypedData ()
 Empty constructor. More...
 
bool Init (const Handle< NCollection_BaseAllocator > &theAlloc, Standard_Size theSizeX, Standard_Size theSizeY, Standard_Size theSizeRowBytes=0, Standard_Byte *theDataPtr=0)
 Initializer. More...
 
void Init (const PixelType_t &theValue)
 Reset all values to specified one. More...
 
const PixelType_t * Row (Standard_Size theRow) const
 
PixelType_t * ChangeRow (Standard_Size theRow)
 
const PixelType_t & Value (Standard_Size theRow, Standard_Size theCol) const
 
PixelType_t & ChangeValue (Standard_Size theRow, Standard_Size theCol)
 
- Public Member Functions inherited from Image_PixMapData
 Image_PixMapData ()
 Empty constructor. More...
 
bool Init (const Handle< NCollection_BaseAllocator > &theAlloc, const Standard_Size theSizeBPP, const Standard_Size theSizeX, const Standard_Size theSizeY, const Standard_Size theSizeRowBytes, Standard_Byte *theDataPtr)
 Initializer. More...
 
void ZeroData ()
 Reset all values to zeros. More...
 
const Standard_ByteRow (const Standard_Size theRow) const
 
Standard_ByteChangeRow (const Standard_Size theRow)
 
const Standard_ByteValue (const Standard_Size theRow, const Standard_Size theCol) const
 
Standard_ByteChangeValue (const Standard_Size theRow, const Standard_Size theCol)
 
Standard_Size MaxRowAligmentBytes () const
 Compute the maximal row alignment for current row size. More...
 
void SetTopDown (const bool theIsTopDown)
 Setup scanlines order in memory - top-down or bottom-up. Drawers should explicitly specify this value if current state IsTopDown() was ignored! More...
 
- Public Member Functions inherited from NCollection_Buffer
 NCollection_Buffer (const Handle< NCollection_BaseAllocator > &theAlloc, const Standard_Size theSize=0, Standard_Byte *theData=NULL)
 Default constructor. When theData is NULL but theSize is not 0 than buffer of specified size will be allocated. More...
 
 ~NCollection_Buffer ()
 Destructor. More...
 
const Standard_ByteData () const
 
Standard_ByteChangeData ()
 
bool IsEmpty () const
 
Standard_Size Size () const
 Return buffer length in bytes. More...
 
const Handle< NCollection_BaseAllocator > & Allocator () const
 
void SetAllocator (const Handle< NCollection_BaseAllocator > &theAlloc)
 Assign new buffer allocator with de-allocation of buffer. More...
 
bool Allocate (const Standard_Size theSize)
 Allocate the buffer. More...
 
void Free ()
 De-allocate buffer. More...
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
 Dumps the content of me into the stream. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean IsKind (const opencascade::handle< Standard_Type > &theType) const
 Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_Boolean IsKind (const Standard_CString theTypeName) const
 Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...
 
Standard_TransientThis () const
 Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Data Fields inherited from Image_PixMapData
Standard_Size SizeBPP
 bytes per pixel More...
 
Standard_Size SizeX
 width in pixels More...
 
Standard_Size SizeY
 height in pixels More...
 
Standard_Size SizeRowBytes
 number of bytes per line (in most cases equal to 3 * sizeX) More...
 
Standard_Size TopToDown
 image scanlines direction in memory from Top to the Down More...
 
- Protected Attributes inherited from Image_PixMapData
Standard_BytemyTopRowPtr
 pointer to the topmost row (depending on scanlines order in memory) More...
 
- Protected Attributes inherited from NCollection_Buffer
Standard_BytemyData
 data pointer More...
 
Standard_Size mySize
 buffer length in bytes More...
 
Handle< NCollection_BaseAllocatormyAllocator
 buffer allocator More...
 

Detailed Description

template<typename PixelType_t>
class Image_PixMapTypedData< PixelType_t >

Structure to manage image buffer with predefined pixel type.

Constructor & Destructor Documentation

◆ Image_PixMapTypedData()

template<typename PixelType_t >
Image_PixMapTypedData< PixelType_t >::Image_PixMapTypedData ( )
inline

Empty constructor.

Member Function Documentation

◆ ChangeRow()

template<typename PixelType_t >
PixelType_t* Image_PixMapTypedData< PixelType_t >::ChangeRow ( Standard_Size  theRow)
inline
Returns
data pointer to requested row (first column).

◆ ChangeValue()

template<typename PixelType_t >
PixelType_t& Image_PixMapTypedData< PixelType_t >::ChangeValue ( Standard_Size  theRow,
Standard_Size  theCol 
)
inline
Returns
data pointer to requested position.

◆ Init() [1/2]

template<typename PixelType_t >
bool Image_PixMapTypedData< PixelType_t >::Init ( const Handle< NCollection_BaseAllocator > &  theAlloc,
Standard_Size  theSizeX,
Standard_Size  theSizeY,
Standard_Size  theSizeRowBytes = 0,
Standard_Byte theDataPtr = 0 
)
inline

Initializer.

◆ Init() [2/2]

template<typename PixelType_t >
void Image_PixMapTypedData< PixelType_t >::Init ( const PixelType_t &  theValue)
inline

Reset all values to specified one.

◆ Row()

template<typename PixelType_t >
const PixelType_t* Image_PixMapTypedData< PixelType_t >::Row ( Standard_Size  theRow) const
inline
Returns
data pointer to requested row (first column).

◆ Value()

template<typename PixelType_t >
const PixelType_t& Image_PixMapTypedData< PixelType_t >::Value ( Standard_Size  theRow,
Standard_Size  theCol 
) const
inline
Returns
data pointer to requested position.

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