This is the documentation for Enlighten.

class Enlighten ConstLightValueIterator

class Enlighten::ConstLightValueIterator

Const LightValue iterator. This contains the logic for iterating over LightValue64 or LightValue128 arrays.

Functions

Name Description
AtEnd()

Iterator at the end of the array.

ConstLightValueIterator(const void *, size_t, Geo::u32)

Construct an iterator.

GetPtr()

Get a ptr to the data.

GetStride()

Get the size of the elements.

operator Geo::v128()

Get the uncompressed version of the underlying data.

operator*(Geo::v128)

Multiply v128.

operator[](Geo::u32)

Access the LightValue through an array accessor.

operator+(Geo::u32)

Access value num elements forward in the array.

operator+(Geo::v128)

Add v128.

operator++()

Pre-increment next value.

operator++(int)

Post-increment next value.

operator+=(Geo::u32)

Jump forward num light values in the array.

Size()

Num elements till the end of the array.,.


bool Enlighten::ConstLightValueIterator::AtEnd


public: bool AtEnd() const


Iterator at the end of the array.


GEO_FORCE_INLINE Enlighten::ConstLightValueIterator::ConstLightValueIterator


public: GEO_FORCE_INLINE ConstLightValueIterator
(
    const void * data,
    size_t stride,
    Geo::u32 numValues
)


Construct an iterator.


const Geo::u8* Enlighten::ConstLightValueIterator::GetPtr


public: const Geo::u8 * GetPtr() const


Get a ptr to the data.


size_t Enlighten::ConstLightValueIterator::GetStride


public: size_t GetStride() const


Get the size of the elements.


GEO_FORCE_INLINE Enlighten::ConstLightValueIterator::operator Geo::v128


public: GEO_FORCE_INLINE operator Geo::v128() const


Get the uncompressed version of the underlying data.


GEO_FORCE_INLINE Geo::v128 Enlighten::ConstLightValueIterator::operator*


public: GEO_FORCE_INLINEGeo::v128 operator*
(
    Geo::v128 value
) const


Multiply v128.


GEO_FORCE_INLINE Geo::v128 Enlighten::ConstLightValueIterator::operator[]


public: GEO_FORCE_INLINEGeo::v128 operator[]
(
    Geo::u32 index
) const


Access the LightValue through an array accessor.


GEO_FORCE_INLINE ConstLightValueIterator Enlighten::ConstLightValueIterator::operator+


public: GEO_FORCE_INLINEConstLightValueIterator operator+
(
    Geo::u32 num
)


Access value num elements forward in the array.


GEO_FORCE_INLINE Geo::v128 Enlighten::ConstLightValueIterator::operator+


public: GEO_FORCE_INLINEGeo::v128 operator+
(
    Geo::v128 value
)


Add v128.


GEO_FORCE_INLINE ConstLightValueIterator& Enlighten::ConstLightValueIterator::operator++


public: GEO_FORCE_INLINEConstLightValueIterator & operator++()


Pre-increment next value.


GEO_FORCE_INLINE ConstLightValueIterator Enlighten::ConstLightValueIterator::operator++


public: GEO_FORCE_INLINEConstLightValueIterator operator++
(
    int
)


Post-increment next value.


GEO_FORCE_INLINE ConstLightValueIterator& Enlighten::ConstLightValueIterator::operator+=


public: GEO_FORCE_INLINEConstLightValueIterator & operator+=
(
    Geo::u32 num
)


Jump forward num light values in the array.


size_t Enlighten::ConstLightValueIterator::Size


public: size_t Size() const


Num elements till the end of the array.,.