This is the documentation for Enlighten.

class Enlighten VisibilityBuffer

class Enlighten::VisibilityBuffer

Encapsulation of light visibility information.

Functions

Name Description
GetClusterVisibilityFactor(Geo::u32, Geo::u32)

Gets the cluster visibility factor for the given cluster.

GetFourSampleVisibilityFactors(Geo::u32, Geo::u32)

Load the next four consecutive visibility bytes into each channel of the v128.

GetMaskedIndex(Geo::u32, Geo::u32)

Gets the masked index for the given cluster and quad.

GetQuadVisibilityMask(Geo::u32, Geo::u32)

Gets the quad visibility mask for the given quad.

GetVisibilityData()

Gets the raw visibility data.

VisibilityBuffer(const VisibilityFormat::Type, const void *)

Constructor.


GEO_CONTROLLED_INLINE Geo::v128 Enlighten::VisibilityBuffer::GetClusterVisibilityFactor


public: GEO_CONTROLLED_INLINEGeo::v128 GetClusterVisibilityFactor
(
    Geo::u32 clusterIdx,
    Geo::u32 hasVisibility
) const


Gets the cluster visibility factor for the given cluster.


GEO_CONTROLLED_INLINE Geo::v128 Enlighten::VisibilityBuffer::GetFourSampleVisibilityFactors


public: GEO_CONTROLLED_INLINEGeo::v128 GetFourSampleVisibilityFactors
(
    Geo::u32 startIdx,
    Geo::u32 hasVisibility
) const


Load the next four consecutive visibility bytes into each channel of the v128.


GEO_CONTROLLED_INLINE Geo::u32 Enlighten::VisibilityBuffer::GetMaskedIndex


public: GEO_CONTROLLED_INLINEGeo::u32 GetMaskedIndex
(
    Geo::u32 clusterIdx,
    Geo::u32 quadIdx
)


Gets the masked index for the given cluster and quad.


GEO_CONTROLLED_INLINE Geo::v128 Enlighten::VisibilityBuffer::GetQuadVisibilityMask


public: GEO_CONTROLLED_INLINEGeo::v128 GetQuadVisibilityMask
(
    Geo::u32 quadIdx,
    Geo::u32 hasVisibility
) const


Gets the quad visibility mask for the given quad.


const Geo::u8* Enlighten::VisibilityBuffer::GetVisibilityData


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


Gets the raw visibility data.


Enlighten::VisibilityBuffer::VisibilityBuffer


public: VisibilityBuffer
(
    const VisibilityFormat::Type format,
    const void * visibilityData
)


Constructor.