This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

class Enlighten::LightTransportPixel

Debugging output representation of an output pixel.

Functions

Name Description
Clone()

Return a deep copy of this object.

Create()

Constructor.

GEO_PROPERTY(Geo::v128, m_Centre)

Estimated centre of the pixel in world space.

GEO_PROPERTY(Geo::GeoBoundingBox, m_BoundingBox)

Estimated axis aligned boundingbox of the pixel in world space. NOTE: This can be a poor estimate in some cases.

GEO_PROPERTY(Geo::GeoRaySet, m_BackFaceLineSegments)

List of ray segments between ray origins and backfaces.

GEO_PROPERTY(GeoRayOriginList, m_ValidRayOrigins)

List of valid ray origins.

GEO_PROPERTY(GeoRayOriginList, m_InvalidRayOrigins)

List of rejected ray origins.

GEO_PROPERTY(Geo::u16, m_AtlasX)

Output atlas x position of the pixel.

GEO_PROPERTY(Geo::u16, m_AtlasY)

Output atlas y position of the pixel.

GEO_PROPERTY(Geo::u32, m_BucketIdx)

Bucket index.

GEO_PROPERTY(Geo::u32, m_PixelIdx)

Pixel index.

GEO_PROPERTY_FLAKY(Geo::v128, m_AverageIrradianceNormal)

Average irradiance normal for the pixel.

Load(Geo::IGeoInputStream &)

Deserialise pixel from stream.

Release()

Destructor.

Save(Geo::IGeoStream &)

Serialise pixel to stream.

Save(Writer &)

Write to any type compatible with IffWriter.


LightTransportPixel* Enlighten::LightTransportPixel::Clone


public: LightTransportPixel * Clone()


Return a deep copy of this object.


static LightTransportPixel* Enlighten::LightTransportPixel::Create


public: LightTransportPixel * Create()


Constructor.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::v128 ,
    m_Centre
)


Estimated centre of the pixel in world space.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::GeoBoundingBox ,
    m_BoundingBox
)


Estimated axis aligned boundingbox of the pixel in world space. NOTE: This can be a poor estimate in some cases.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::GeoRaySet ,
    m_BackFaceLineSegments
)


List of ray segments between ray origins and backfaces.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    GeoRayOriginList ,
    m_ValidRayOrigins
)


List of valid ray origins.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    GeoRayOriginList ,
    m_InvalidRayOrigins
)


List of rejected ray origins.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::u16 ,
    m_AtlasX
)


Output atlas x position of the pixel.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::u16 ,
    m_AtlasY
)


Output atlas y position of the pixel.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::u32 ,
    m_BucketIdx
)


Bucket index.


Enlighten::LightTransportPixel::GEO_PROPERTY


public: GEO_PROPERTY
(
    Geo::u32 ,
    m_PixelIdx
)


Pixel index.


Enlighten::LightTransportPixel::GEO_PROPERTY_FLAKY


public: GEO_PROPERTY_FLAKY
(
    Geo::v128 ,
    m_AverageIrradianceNormal
)


Average irradiance normal for the pixel.


bool Enlighten::LightTransportPixel::Load


public: bool Load
(
    Geo::IGeoInputStream & reader
)


Deserialise pixel from stream.


virtual void Enlighten::LightTransportPixel::Release


public: virtual void Release()


Destructor.


bool Enlighten::LightTransportPixel::Save


public: bool Save
(
    Geo::IGeoStream & writer
) const


Serialise pixel to stream.


bool Enlighten::LightTransportPixel::Save


public: bool Save
(
    Writer & writer
) const


Write to any type compatible with IffWriter.

  • No labels