Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)

Enlighten API 3.10 Documentation
Results will update as you type.
  • class Enlighten ILogHandler
  • class Enlighten IMeshSimpOutput
  • class Enlighten ImporterScene
  • class Enlighten IncidentLightingBuffer
  • class Enlighten IndirectInputLightingInternalParameters
  • class Enlighten IndirectInputLightingParameters
  • class Enlighten InputLightBase
  • class Enlighten InputLightFalloffTable
  • class Enlighten InputLightingBuffer
  • class Enlighten InputOctreeBuilder
  • class Enlighten InputTextureSamplerParameters
  • class Enlighten InputWorkspace
  • class Enlighten InputWorkspaceDebugIterator
  • class Enlighten InputWorkspaceDebugPoint
  • class Enlighten InputWorkspaceDynamicInternal
  • class Enlighten InputWorkspaceInternal
  • class Enlighten InputWorkspaceMetaData
  • class Enlighten InternalLightFalloffTable
  • class Enlighten InterpolatedPoint
  • class Enlighten InterpolationInputSet
  • class Enlighten IPppiTextureUpdateHandler
  • class Enlighten IPrecompBuildParameters
  • class Enlighten IPrecompCubeMapBuildParameters
  • class Enlighten IPrecompCubeMapCore
  • class Enlighten IPrecompDepthCubeMap
  • class Enlighten IPrecompGeneratedSystems
  • class Enlighten IPrecompInputCubeMap
  • class Enlighten IPrecompInputGeometry
  • class Enlighten IPrecompInputItemDependencies
  • class Enlighten IPrecompInputMesh
  • class Enlighten IPrecompInputProbeOctree
  • class Enlighten IPrecompInputProbeRegion
  • class Enlighten IPrecompInputProbeSet
  • class Enlighten IPrecompInputSystem
  • class Enlighten IPrecompMeshValidation
  • class Enlighten IPrecompOutputCubeMap
  • class Enlighten IPrecompOutputProbeOctree
  • class Enlighten IPrecompOutputProbeSet
  • class Enlighten IPrecompPackedGeometry
  • class Enlighten IPrecompPackedInstance
  • class Enlighten IPrecompPackedSystem
  • class Enlighten IPrecompProbeSetBuildParameters
  • class Enlighten IPrecompProbeSetRadiosity
  • class Enlighten IPrecompRadiosityNormalTexture
  • class Enlighten IPrecompSystemClustering
  • class Enlighten IPrecompSystemCompressedLightTransport
  • class Enlighten IPrecompSystemDependencies
  • class Enlighten IPrecompSystemDuster
  • class Enlighten IPrecompSystemLightTransport
  • class Enlighten IPrecompSystemPreClustering
  • class Enlighten IPrecompSystemRadiosity
  • class Enlighten IPrecompSystemsDependencies
  • class Enlighten IPrecompute
  • class Enlighten IPrecomputeLoaderCubeMap
  • class Enlighten IPrecomputeLoaderGeometry
  • class Enlighten IPrecomputeLoaderProbeSet
  • class Enlighten IPrecomputeLoaderSystem
  • class Enlighten IPrecompVolumeQuery
  • class Enlighten IProbeSetManager
  • class Enlighten IrradianceOutputDesc
  • class Enlighten ISystemSolutionSpace
  • class Enlighten IThreadGroup
  • class Enlighten IUpdateManager
  • class Enlighten IUpdateManagerWorker
  • class Enlighten IViewVolumeIntersector
  • class Enlighten LightMethodSelector
  • class Enlighten LightTransportPixel
  • class Enlighten LightValue64
  • class Enlighten LightValueIterator
  • class Enlighten Line2D
  • class Enlighten LongRunningProcess
  • class Enlighten LrbCpuTextureSampler
  • class Enlighten MaterialAlbedoSampler
  • class Enlighten MaterialComponentBuffer
  • class Enlighten MaterialEmissiveSampler
  • class Enlighten MaterialGuids
  • class Enlighten MaterialSampler
  • class Enlighten MaterialTransparencySampler
  • class Enlighten MergeGeometry
  • class Enlighten MergeGeometryCache
  • class Enlighten MergeMap
    Calendars

You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompPackedSystem

    This is the documentation for Enlighten.

    class Enlighten IPrecompPackedSystem

    Nov 21, 2019

    class Enlighten::IPrecompPackedSystem

        └>Geo::IGeoSerialisable
            └>Geo::IGeoReleasable

    Class encapsulating the geometry and additional data for a system, light-mapped or otherwise.

    Functions

    Name Description
    Create()

    Create a new empty IPrecompPackedSystem that you can load data into.

    Create(const IPrecompBuildParameters *)

    Create a new empty IPrecompPackedSystem with tweakable parameters that you can load data into.

    GetBoundingBox()

    Return a bounding box of this system.

    GetBuildParameters()

    Return a pointer to the build parameters used when creating this system.

    GetId()

    Return the unique ID of this system.

    GetLod(Geo::s32)

    Access the IPrecompPackedSystem representing the LOD version of the system. GetLod(0) will return the pointer to the main system (i.e. this system)

    GetMaxOutputPixelSize()

    Return maximum world pixel size used by this system.

    GetMeshSimpOutput()

    Return a pointer to data that describes the result of the mesh simplification.

    GetMinOutputPixelSize()

    Return minimum world pixel size used by this system.

    GetName()

    Get the full name.

    GetNumInstances()

    Return the number of geometry output instances contained within this system.

    GetNumLods()

    LOD access For systems with no LODs generated GetNumLods will return 1 (i.e.

    GetOutputHeight()

    Return the hight of the system output texture.

    GetOutputWidth()

    Return the width of the system output texture.

    GetPackedInstances()

    Return a pointer to the output instances.

    GetSurfaceArea()

    Return total surface area of this system.

    Load(IGeoInputStream &, Geo::u32)

    Load an instance of this class from an IGeoInputStream.

    Release()

    Free this object that was created within the Enlighten libraries.

    Save(IGeoStream &, Geo::u32)

    Save an instance of this class to an IGeoStream.


    static IPrecompPackedSystem* Enlighten::IPrecompPackedSystem::Create


    public: IPrecompPackedSystem * Create()


    Create a new empty IPrecompPackedSystem that you can load data into.


    static IPrecompPackedSystem* Enlighten::IPrecompPackedSystem::Create


    public: IPrecompPackedSystem * Create
    (
        const IPrecompBuildParameters * params
    )


    Create a new empty IPrecompPackedSystem with tweakable parameters that you can load data into.


    virtual const Geo::GeoBoundingBox& Enlighten::IPrecompPackedSystem::GetBoundingBox


    public: const Geo::GeoBoundingBox & GetBoundingBox() const


    Return a bounding box of this system.


    virtual const IPrecompBuildParameters* Enlighten::IPrecompPackedSystem::GetBuildParameters


    public: const IPrecompBuildParameters * GetBuildParameters() const


    Return a pointer to the build parameters used when creating this system.


    virtual Geo::GeoGuid Enlighten::IPrecompPackedSystem::GetId


    public: Geo::GeoGuid GetId() const


    Return the unique ID of this system.


    virtual const IPrecompPackedSystem* Enlighten::IPrecompPackedSystem::GetLod


    public: const IPrecompPackedSystem * GetLod
    (
        Geo::s32 lodIndex
    ) const


    Access the IPrecompPackedSystem representing the LOD version of the system. GetLod(0) will return the pointer to the main system (i.e. this system)


    virtual float Enlighten::IPrecompPackedSystem::GetMaxOutputPixelSize


    public: float GetMaxOutputPixelSize() const


    Return maximum world pixel size used by this system.


    virtual const IMeshSimpOutput* Enlighten::IPrecompPackedSystem::GetMeshSimpOutput


    public: const IMeshSimpOutput * GetMeshSimpOutput() const


    Return a pointer to data that describes the result of the mesh simplification.


    virtual float Enlighten::IPrecompPackedSystem::GetMinOutputPixelSize


    public: float GetMinOutputPixelSize() const


    Return minimum world pixel size used by this system.


    virtual const char* Enlighten::IPrecompPackedSystem::GetName


    public: const char * GetName() const


    Get the full name.


    virtual Geo::s32 Enlighten::IPrecompPackedSystem::GetNumInstances


    public: Geo::s32 GetNumInstances() const


    Return the number of geometry output instances contained within this system.


    virtual Geo::s32 Enlighten::IPrecompPackedSystem::GetNumLods


    public: Geo::s32 GetNumLods() const


    LOD access For systems with no LODs generated GetNumLods will return 1 (i.e.

    the main system is considered to be the first LOD)


    virtual Geo::s32 Enlighten::IPrecompPackedSystem::GetOutputHeight


    public: Geo::s32 GetOutputHeight() const


    Return the hight of the system output texture.


    virtual Geo::s32 Enlighten::IPrecompPackedSystem::GetOutputWidth


    public: Geo::s32 GetOutputWidth() const


    Return the width of the system output texture.


    virtual const IPrecompPackedInstance** Enlighten::IPrecompPackedSystem::GetPackedInstances


    public: const IPrecompPackedInstance ** GetPackedInstances() const


    Return a pointer to the output instances.


    virtual double Enlighten::IPrecompPackedSystem::GetSurfaceArea


    public: double GetSurfaceArea() const


    Return total surface area of this system.


    virtual bool Geo::IGeoSerialisable::Load


    public: bool Load
    (
        IGeoInputStream & stream,
        Geo::u32 section
    )


    Load an instance of this class from an IGeoInputStream.

    The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


    virtual void Geo::IGeoReleasable::Release


    public: void Release()


    Free this object that was created within the Enlighten libraries.

    Expect this to behave in a similar way to calling 'delete(this)'


    virtual bool Geo::IGeoSerialisable::Save


    public: bool Save
    (
        IGeoStream & stream,
        Geo::u32 section
    ) const


    Save an instance of this class to an IGeoStream.

    The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.

    , multiple selections available,
    {"serverDuration": 10, "requestCorrelationId": "a02f1b6c4586409ba0770dbee74fdc57"}