class Enlighten MaterialComponentBuffer

This is the documentation for Enlighten.

class Enlighten MaterialComponentBuffer

template<typename Colour>
class Enlighten::MaterialComponentBuffer

 

MaterialComponentBuffer type interface.

Typedefs

Name

Description

Name

Description

GenericColourBuffer< ColourType > BaseType

Concrete type of the base class.

Colour ColourType

Colour type stored in this buffer.

C ColourType

Colour type.

BaseType::ConstIteratorType ConstIteratorType

ConstIterator type.

ConstIterator< ColourType > ConstIteratorType

Const Iterator type.

BaseType::IteratorType IteratorType

Iterator type.

Iterator< ColourType > IteratorType

Iterator type.

Functions

Name

Description

Name

Description

Begin()

Return a const iterator at the beginning of this buffer.

Begin()

Return an iterator at the beginning of this buffer.

Begin()

Returns an iterator to the first value in the buffer.

Begin()

Returns a const iterator to the first value in the buffer.

ByteSwapMembers()

Endian swap the members of the header.

ByteSwapPayload(Geo::EConvertEndianMode)

Endian swap the buffer contents.

CalculateBufferSize(Geo::s32)

Returns the size of the buffer in bytes.

CalculateBufferSize(const InputWorkspace *)

Calculate the size of the buffer for a given InputWorkspace.

Clear()

Reset the contents of this buffer to zero/black.

Clear()

Reset the contents of this buffer to zero/black.

ConvertEndian(Geo::EConvertEndianMode)

Endian swap the buffer.

ConvertEndian(Geo::EConvertEndianMode)

Endian swap the buffer.

Copy(const GenericColourBuffer< ColourType > &)

Copy values from another buffer.

Copy(const MaterialComponentBuffer &)

Copy values from another buffer.

Create(const InputWorkspace *, void *)

Create a buffer for a given workspace in the supplied memory.

Create(const MaterialComponentBuffer &, void *)

Create a duplicated buffer from the source, in the supplied memory.

Create(Geo::GeoGuid, Geo::s32, void *)

Creates a buffer in memory.

Create(void *, const GenericColourBuffer &)

Creates a copy in memory.

End()

Returns a const iterator to the last+1 value in the buffer.

End()

Return an iterator at the end of this buffer.

End()

Return a const iterator at the end of this buffer.

End()

Returns an iterator to the last+1 value in the buffer.

GenericColourBuffer(Geo::GeoGuid, Geo::s32, Geo::s32)

Main constructor.

GenericColourBuffer(const GenericColourBuffer &)

Copy constructor.

GetNumValues()

Returns the number of values in this buffer.

GetNumValues()

Returns the number of values in this buffer.

GetSize()

Returns the size of this buffer in bytes.

GetSize()

Returns the size of this buffer in bytes.

GetSystemId()

Returns the guid of the system that this buffer correlates to.

GetSystemId()

Returns the guid of the system that this buffer correlates to.