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 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
  • class Enlighten MaterialEmissiveSampler
  • class Enlighten MaterialGuids
  • class Enlighten MaterialSampler
  • class Enlighten MaterialTransparencySampler
  • class Enlighten MergeGeometry
  • class Enlighten MergeGeometryCache
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompPackedInstance

    This is the documentation for Enlighten.

    class Enlighten IPrecompPackedInstance

    Nov 21, 2019

    class Enlighten::IPrecompPackedInstance

    Handle to the PackedInstance.

    Functions

    Name Description
    GetClusterSize()

    Returns system's cluster size override for this instance.

    GetGeometryId()

    Get the Geometry ID of this instance.

    GetInstanceGuid()

    Get the original user-set GUID of this instance.

    GetInstanceId()

    Get the original ID of this instance.

    GetInstanceIdx()

    Get the original ID of this instance.

    GetNumMeshes()

    Gets the number of meshes that were in the geometry object this instance was built from.

    GetNumVerts(Geo::s32)

    Returns the number of vertices for the mesh at index meshIdx.

    GetOutputUvArray(Geo::s32)

    Returns a pointer to the per-vertex uvs for the mesh at index meshIdx.

    GetProjectionCost()

    Gets the total projection cost over all meshes.

    GetProjectionCost(Geo::s32)

    Gets the projection cost for the given mesh.

    GetUvTransform()

    Get per-instance 2d UV packed-instance to packed-system transform.


    virtual float Enlighten::IPrecompPackedInstance::GetClusterSize

    public: float GetClusterSize() const

    Returns system's cluster size override for this instance.

    If non-negative, this specifies a per-instance cluster size, overriding the value set for the system to which this instance belongs.

    Returns

    system's cluster size override for this instance.


    virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetGeometryId

    public: Geo::GeoGuid GetGeometryId() const

    Get the Geometry ID of this instance.


    virtual Geo::GeoGuid Enlighten::IPrecompPackedInstance::GetInstanceGuid

    public: Geo::GeoGuid GetInstanceGuid() const

    Get the original user-set GUID of this instance.


    virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetInstanceId

    public: Geo::s32 GetInstanceId() const

    Get the original ID of this instance.


    virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetInstanceIdx

    public: virtual Geo::s32 GetInstanceIdx() const

    Get the original ID of this instance.

    Deprecated

    Please use GetInstanceId() instead, which returns the same value but is more accurately named.


    virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetNumMeshes

    public: Geo::s32 GetNumMeshes() const

    Gets the number of meshes that were in the geometry object this instance was built from.


    virtual Geo::s32 Enlighten::IPrecompPackedInstance::GetNumVerts

    public: Geo::s32 GetNumVerts
    (
        Geo::s32 meshIdx
    ) const

    Returns the number of vertices for the mesh at index meshIdx.

    Parameters
    [in] meshIdx

    This should be a valid index between [0, GetNumMeshes()-1].

    Returns

    The number of verts or -1 if the meshIdx is invalid.


    virtual const Geo::GeoPoint2* Enlighten::IPrecompPackedInstance::GetOutputUvArray

    public: const Geo::GeoPoint2 * GetOutputUvArray
    (
        Geo::s32 meshIdx
    ) const

    Returns a pointer to the per-vertex uvs for the mesh at index meshIdx.

    Parameters
    [in] meshIdx

    This should be a valid index between [0, GetNumMeshes()-1].

    Returns

    A const pointer to an array of uvs or NULL if the meshIdx is invalid.


    virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost

    public: float GetProjectionCost() const

    Gets the total projection cost over all meshes.


    virtual float Enlighten::IPrecompPackedInstance::GetProjectionCost

    public: float GetProjectionCost
    (
        Geo::s32 meshIdx
    ) const

    Gets the projection cost for the given mesh.


    virtual Geo::Geo2DTransform Enlighten::IPrecompPackedInstance::GetUvTransform

    public: Geo::Geo2DTransform GetUvTransform() const

    Get per-instance 2d UV packed-instance to packed-system transform.

    , multiple selections available,
    {"serverDuration": 9, "requestCorrelationId": "acb9070b0d81465baf4bd49902085fc1"}