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 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
  • class Enlighten MergeProcessParams
  • class Enlighten MergeStats
  • class Enlighten MergeTriGroupParams
  • class Enlighten MetaBlock
  • class Enlighten MetaBlockBuilder
  • class Enlighten MultithreadCpuUpdateManager
  • class Enlighten MultithreadCpuWorker
    Calendars

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

    This is the documentation for Enlighten.

    class Enlighten IPrecompSystemDuster

    Nov 21, 2019

    class Enlighten::IPrecompSystemDuster

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

    Handle to the platform-agnostic input sample points (dusters).

    This class also has accessor functions for getting at the uncompressed input sample points. These are the same points used by the runtime, but the runtime versions stored in InputWorkspace have been compressed/quantised. If you need the original uncompressed versions for offline work you should take them from here.

    Functions

    Name Description
    Create()

    Create a new empty IPrecompSystemDuster to load data into.

    GetBuildParameters()

    Get the build parameters this system was built with.

    GetId()

    Return the unique ID of this system.

    GetInputSamplePointBaryCoords()

    Get an array of the barycentric coordinates for each input sample point.

    GetInputSamplePointFaceIndices()

    Get an array of indices for each input sample point, identifying which face in its mesh this point is associated with.

    GetInputSamplePointInstanceGuids()

    Get an array of GUIDs for each input sample point, identifying which instance in the system this point is associated with.

    GetInputSamplePointInstanceIds()

    Get an array of IDs for each input sample point, identifying which instance in the system this point is associated with.

    GetInputSamplePointMeshGuids()

    Get an array of GUIDs for each input sample point, identifying which mesh this point is associated with.

    GetInputSamplePointMeshIndices()

    Get an array of indices for each input sample point, identifying which mesh in its instance this point is associated with.

    GetInputSamplePointNormals()

    Get an array of the input sample point normals.

    GetInputSamplePointPositions()

    Get an array of the input sample point positions.

    GetInputSamplePointRadiosityUvs(Geo::s32)

    Get an array of the input sample point radiosity UVs (in the xy components) for given (lodIndex) Lod of the System.

    GetName()

    Get the full name.

    GetNumInputSamplePoints()

    Get the number of input sample points.

    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 IPrecompSystemDuster* Enlighten::IPrecompSystemDuster::Create


    public: IPrecompSystemDuster * Create()


    Create a new empty IPrecompSystemDuster to load data into.


    virtual const IPrecompBuildParameters* Enlighten::IPrecompSystemDuster::GetBuildParameters


    public: const IPrecompBuildParameters * GetBuildParameters() const


    Get the build parameters this system was built with.


    virtual Geo::GeoGuid Enlighten::IPrecompSystemDuster::GetId


    public: Geo::GeoGuid GetId() const


    Return the unique ID of this system.


    virtual const Geo::GeoPoint2* Enlighten::IPrecompSystemDuster::GetInputSamplePointBaryCoords


    public: const Geo::GeoPoint2 * GetInputSamplePointBaryCoords() const


    Get an array of the barycentric coordinates for each input sample point.

    The array length matches GetNumInputSamplePoints().


    virtual const Geo::s32* Enlighten::IPrecompSystemDuster::GetInputSamplePointFaceIndices


    public: const Geo::s32 * GetInputSamplePointFaceIndices() const


    Get an array of indices for each input sample point, identifying which face in its mesh this point is associated with.

    The indices index into the face array of the associated mesh. The array length matches GetNumInputSamplePoints().


    virtual const Geo::GeoGuid* Enlighten::IPrecompSystemDuster::GetInputSamplePointInstanceGuids


    public: const Geo::GeoGuid * GetInputSamplePointInstanceGuids() const


    Get an array of GUIDs for each input sample point, identifying which instance in the system this point is associated with.

    The GUIDs are the same GUID value provided when adding instances to an input system. The array length matches GetNumInputSamplePoints().


    virtual const Geo::s32* Enlighten::IPrecompSystemDuster::GetInputSamplePointInstanceIds


    public: const Geo::s32 * GetInputSamplePointInstanceIds() const


    Get an array of IDs for each input sample point, identifying which instance in the system this point is associated with.

    The IDs are the same ID value provided when adding instances to an input system. The array length matches GetNumInputSamplePoints().


    virtual const Geo::GeoGuid* Enlighten::IPrecompSystemDuster::GetInputSamplePointMeshGuids


    public: const Geo::GeoGuid * GetInputSamplePointMeshGuids() const


    Get an array of GUIDs for each input sample point, identifying which mesh this point is associated with.

    The GUIDs are the same as those provided when adding IPrecompInputMeshes to an IPrecompInputGeometry. The array length matches GetNumInputSamplePoints().


    virtual const Geo::s32* Enlighten::IPrecompSystemDuster::GetInputSamplePointMeshIndices


    public: const Geo::s32 * GetInputSamplePointMeshIndices() const


    Get an array of indices for each input sample point, identifying which mesh in its instance this point is associated with.

    The indices index into the array of meshes in the associated geometry object. The array length matches GetNumInputSamplePoints().


    virtual const Geo::v128* Enlighten::IPrecompSystemDuster::GetInputSamplePointNormals


    public: const Geo::v128 * GetInputSamplePointNormals() const


    Get an array of the input sample point normals.

    The w component is always 0. The array length matches GetNumInputSamplePoints().


    virtual const Geo::v128* Enlighten::IPrecompSystemDuster::GetInputSamplePointPositions


    public: const Geo::v128 * GetInputSamplePointPositions() const


    Get an array of the input sample point positions.

    The w component is always 1. The array length matches GetNumInputSamplePoints().


    virtual const Geo::v128* Enlighten::IPrecompSystemDuster::GetInputSamplePointRadiosityUvs


    public: const Geo::v128 * GetInputSamplePointRadiosityUvs
    (
        Geo::s32 lodIndex
    ) const


    Get an array of the input sample point radiosity UVs (in the xy components) for given (lodIndex) Lod of the System.

    The z and w components are always 0. The array length matches GetNumInputSamplePoints().


    virtual const char* Enlighten::IPrecompSystemDuster::GetName


    public: const char * GetName() const


    Get the full name.


    virtual Geo::s32 Enlighten::IPrecompSystemDuster::GetNumInputSamplePoints


    public: Geo::s32 GetNumInputSamplePoints() const


    Get the number of input sample points.


    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": 9, "requestCorrelationId": "68066cb4e25248ca86278635ee4ce755"}