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 IBakeVisibilityBuffer
  • class Enlighten IClusteringOutput
  • class Enlighten IGpuTexture
  • class Enlighten IGpuTextureAllocator
  • class Enlighten IGpuTextureUpdater
  • class Enlighten ILightTransportOutput
  • class Enlighten ILimiter
  • 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompInputSystem

    This is the documentation for Enlighten.

    class Enlighten IPrecompInputSystem

    Nov 21, 2019

    class Enlighten::IPrecompInputSystem

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

    Handle to the InputSystem.

    Functions

    Name Description
    AddInstances(const PrecompInputInstance *, const PrecompInputInstance *)

    Copy instances between [begin, end) into this object.

    ClearAllMaterialInfo()

    Clears all existing material properties for this system.

    Create()

    Create a new IPrecompInputSystem.

    GetBuildParameters()

    Get the build parameters for this system.

    GetBuildParameters()

    Get the build parameters for this system.

    GetId()

    Returns the globally unique ID of this system.

    GetInstanceArray()

    Access to the array of input instances.

    GetInstanceCount()

    Retrieves the number of object instances in the system.

    GetMaterialInfo(Geo::GeoGuid, Geo::GeoGuid, Geo::GeoGuid, PrecompMaterialInfo &)

    Retrieves the material properties that will be used for the given combination of instance, mesh and material GUID.

    GetName()

    Returns the globally unique name 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.

    SetId(Geo::GeoGuid)

    Sets the globally unique ID of this system.

    SetMaterialInfo(Geo::GeoGuid, Geo::GeoGuid, Geo::GeoGuid, const PrecompMaterialInfo &)

    Sets material properties for the given combination of instance, mesh and material GUIDs.

    SetName(const char *)

    Sets the globally unique name of this system.


    virtual bool Enlighten::IPrecompInputSystem::AddInstances

    public: bool AddInstances
    (
        const PrecompInputInstance * begin,
        const PrecompInputInstance * end
    )

    Copy instances between [begin, end) into this object.

    Parameters
    [in] begin

    A pointer to the first element to be added

    [in] end

    A pointer to an element one past the last entity (as standard STL syntax)

    Returns

    True if operation succeeded, false if there was not enough memory to satisfy request


    virtual void Enlighten::IPrecompInputSystem::ClearAllMaterialInfo

    public: void ClearAllMaterialInfo()

    Clears all existing material properties for this system.


    static IPrecompInputSystem* Enlighten::IPrecompInputSystem::Create

    public: IPrecompInputSystem * Create()

    Create a new IPrecompInputSystem.


    virtual IPrecompBuildParameters* Enlighten::IPrecompInputSystem::GetBuildParameters

    public: IPrecompBuildParameters * GetBuildParameters()

    Get the build parameters for this system.


    virtual const IPrecompBuildParameters* Enlighten::IPrecompInputSystem::GetBuildParameters

    public: const IPrecompBuildParameters * GetBuildParameters() const

    Get the build parameters for this system.


    virtual Geo::GeoGuid Enlighten::IPrecompInputSystem::GetId

    public: Geo::GeoGuid GetId() const

    Returns the globally unique ID of this system.


    virtual const PrecompInputInstance* Enlighten::IPrecompInputSystem::GetInstanceArray

    public: const PrecompInputInstance * GetInstanceArray() const

    Access to the array of input instances.


    virtual Geo::s32 Enlighten::IPrecompInputSystem::GetInstanceCount

    public: Geo::s32 GetInstanceCount() const

    Retrieves the number of object instances in the system.


    virtual void Enlighten::IPrecompInputSystem::GetMaterialInfo

    public: void GetMaterialInfo
    (
        Geo::GeoGuid instanceGuid,
        Geo::GeoGuid meshGuid,
        Geo::GeoGuid materialGuid,
        PrecompMaterialInfo & outMatInfo
    ) const

    Retrieves the material properties that will be used for the given combination of instance, mesh and material GUID.

    If a GUID parameter is passed as GeoGuid::Invalid then the resulting material info will be that for any material use which doesn't have that GUID specified. For example, passing GeoGuid::Invalid for the instanceGuid parameter will return the material used for any instances which don't have a GUID specified.


    virtual const char* Enlighten::IPrecompInputSystem::GetName

    public: const char * GetName() const

    Returns the globally unique name 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.


    virtual void Enlighten::IPrecompInputSystem::SetId

    public: void SetId
    (
        Geo::GeoGuid systemId
    )

    Sets the globally unique ID of this system.


    virtual bool Enlighten::IPrecompInputSystem::SetMaterialInfo

    public: bool SetMaterialInfo
    (
        Geo::GeoGuid instanceGuid,
        Geo::GeoGuid meshGuid,
        Geo::GeoGuid materialGuid,
        const PrecompMaterialInfo & matInfo
    )

    Sets material properties for the given combination of instance, mesh and material GUIDs.

    Passing GeoGuid::Invalid to any of the GUID parameters will result in the material properties being set for all material uses of that type. For example passing a specific instance GUID and GeoGuid::Invalid for the the mesh and material GUIDs will set all the materials uses on that instance, regardless of mesh or material. Subsequent calls to SetMaterialInfo will override (wholly or partially) material properties set by previous calls. For example, setting all materials in the entire system (by passing GeoGuid::Invalid for all three GUID params) and then setting a specific material on a specific mesh on a specific instance.


    virtual void Enlighten::IPrecompInputSystem::SetName

    public: void SetName
    (
        const char * name
    )

    Sets the globally unique name of this system.

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