This is the documentation for Enlighten.

class Enlighten LightValueIterator

class Enlighten::LightValueIterator

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

Functions

Name Description
AtEnd()

At the end of the array.

GetPtr()

Get a pointer to the data.

GetPtr()

Get a pointer to the data.

GetStride()

Get the stride in bytes between elements.

LightValueIterator(void *, size_t, Geo::u32)

Construct an iterator.

operator-(LightValueIterator)

Subtract LightValueIterator.

operator-(Geo::v128)

Subtract v128.

operator Geo::v128()

Get the uncompressed version of the underlying data.

operator*(Geo::v128)

Multiply v128.

operator*=(Geo::v128)

Multiple v128 by the value pointed to by this.

operator[](Geo::u32)

Access the LightValue through an array accessor.

operator+(Geo::u32)

Access value num elements forward in the array.

operator+(Geo::u32)

Access value num elements forward in the array.

operator+(Geo::v128)

Add v128.

operator+(LightValueIterator)

Add LightValueIterator.

operator++()

Pre-increment next value.

operator++(int)

Post-increment next value.

operator+=(Geo::v128)

Add v128 to the value pointed to by this.

operator+=(LightValueIterator)

Add LightValueIterator.

operator+=(Geo::u32)

Jump forward num light values in the array.

operator+=(Geo::u32)

Const jump forward num light values in the array.

operator=(const Geo::v128 &)

Assign a light value a new value.

operator-=(Geo::v128)

Subtract v128.

operator-=(LightValueIterator)

Subtract LightValueIterator.

Size()

Number of elements in the array.


bool Enlighten::LightValueIterator::AtEnd


public: bool AtEnd() const


At the end of the array.


Geo::u8* Enlighten::LightValueIterator::GetPtr


public: Geo::u8 * GetPtr()


Get a pointer to the data.


const Geo::u8* Enlighten::LightValueIterator::GetPtr


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


Get a pointer to the data.


size_t Enlighten::LightValueIterator::GetStride


public: size_t GetStride()


Get the stride in bytes between elements.


GEO_FORCE_INLINE Enlighten::LightValueIterator::LightValueIterator


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


Construct an iterator.


GEO_FORCE_INLINE Geo::v128 Enlighten::LightValueIterator::operator-


public: GEO_FORCE_INLINEGeo::v128 operator-
(
    LightValueIterator other
)


Subtract LightValueIterator.


GEO_FORCE_INLINE Geo::v128 Enlighten::LightValueIterator::operator-


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


Subtract v128.


GEO_FORCE_INLINE Enlighten::LightValueIterator::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::LightValueIterator::operator*


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


Multiply v128.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator*=


public: GEO_FORCE_INLINELightValueIterator & operator*=
(
    Geo::v128 value
)


Multiple v128 by the value pointed to by this.


GEO_FORCE_INLINE LightValueIterator Enlighten::LightValueIterator::operator[]


public: GEO_FORCE_INLINELightValueIterator operator[]
(
    Geo::u32 index
) const


Access the LightValue through an array accessor.


GEO_FORCE_INLINE LightValueIterator Enlighten::LightValueIterator::operator+


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


Access value num elements forward in the array.


GEO_FORCE_INLINE const LightValueIterator Enlighten::LightValueIterator::operator+


public: GEO_FORCE_INLINE const LightValueIterator operator+
(
    Geo::u32 num
) const


Access value num elements forward in the array.


GEO_FORCE_INLINE Geo::v128 Enlighten::LightValueIterator::operator+


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


Add v128.


GEO_FORCE_INLINE Geo::v128 Enlighten::LightValueIterator::operator+


public: GEO_FORCE_INLINEGeo::v128 operator+
(
    LightValueIterator other
)


Add LightValueIterator.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator++


public: GEO_FORCE_INLINELightValueIterator & operator++()


Pre-increment next value.


GEO_FORCE_INLINE LightValueIterator Enlighten::LightValueIterator::operator++


public: GEO_FORCE_INLINELightValueIterator operator++
(
    int
)


Post-increment next value.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator+=


public: GEO_FORCE_INLINELightValueIterator & operator+=
(
    Geo::v128 value
)


Add v128 to the value pointed to by this.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator+=


public: GEO_FORCE_INLINELightValueIterator & operator+=
(
    LightValueIterator other
)


Add LightValueIterator.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator+=


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


Jump forward num light values in the array.


GEO_FORCE_INLINE const LightValueIterator& Enlighten::LightValueIterator::operator+=


public: GEO_FORCE_INLINE const LightValueIterator & operator+=
(
    Geo::u32 num
) const


Const jump forward num light values in the array.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator=


public: GEO_FORCE_INLINELightValueIterator & operator=
(
    const Geo::v128 & value
)


Assign a light value a new value.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator-=


public: GEO_FORCE_INLINELightValueIterator & operator-=
(
    Geo::v128 value
)


Subtract v128.


GEO_FORCE_INLINE LightValueIterator& Enlighten::LightValueIterator::operator-=


public: GEO_FORCE_INLINELightValueIterator & operator-=
(
    LightValueIterator other
)


Subtract LightValueIterator.


size_t Enlighten::LightValueIterator::Size


public: size_t Size() const


Number of elements in the array.