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 IBakeSystemResource
  • class Enlighten IBakeTextureManager
  • 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
    Calendars
You‘re viewing this with anonymous access, so some content might be blocked.
/
class Enlighten IPrecompInputProbeRegion

    This is the documentation for Enlighten.

    class Enlighten IPrecompInputProbeRegion

    Nov 21, 2019

    class Enlighten::IPrecompInputProbeRegion

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

    Represents a region of 3D space voxelized at various resolutions.

    Functions

    Name Description
    AddBoxes(ProbeOctreeResolution, const Geo::GeoBoundingBox *, Geo::s32)

    Extend by the specified array of boxes.

    AddPoints(ProbeOctreeResolution, const Geo::v128 *, Geo::s32)

    Extend by the specified array of points.

    AddVolume(ProbeOctreeResolution, const IPrecompVolumeQuery &)

    Extend by the specified volume.

    Create()

    Create a new empty IPrecompInputProbeRegion.

    Create(float)

    Create a new IPrecompInputProbeRegion that represents a region of 3D space with voxels of the specified size.

    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.


    virtual void Enlighten::IPrecompInputProbeRegion::AddBoxes

    public: void AddBoxes
    (
        ProbeOctreeResolution resolution,
        const Geo::GeoBoundingBox * boxes,
        Geo::s32 count
    )

    Extend by the specified array of boxes.

    Parameters
    [in] resolution

    The desired resolution.

    [in] boxes

    An array of boxes for which probes will be placed.

    [in] count

    Number of boxes in the boxes array.


    virtual void Enlighten::IPrecompInputProbeRegion::AddPoints

    public: void AddPoints
    (
        ProbeOctreeResolution resolution,
        const Geo::v128 * points,
        Geo::s32 count
    )

    Extend by the specified array of points.

    Parameters
    [in] resolution

    The desired resolution.

    [in] points

    An array of points for which probes will be placed at the specified resolution.

    [in] count

    Number of points in the points array.


    virtual void Enlighten::IPrecompInputProbeRegion::AddVolume

    public: void AddVolume
    (
        ProbeOctreeResolution resolution,
        const IPrecompVolumeQuery & query
    )

    Extend by the specified volume.

    Parameters
    [in] resolution

    The desired resolution.

    [in] query

    An implementation of IPrecompVolumeQuery which represents the desired volume. Note: object lifetime must be at least the duration of this method call.


    static IPrecompInputProbeRegion* Enlighten::IPrecompInputProbeRegion::Create

    public: IPrecompInputProbeRegion * Create()

    Create a new empty IPrecompInputProbeRegion.


    static IPrecompInputProbeRegion* Enlighten::IPrecompInputProbeRegion::Create

    public: IPrecompInputProbeRegion * Create
    (
        float voxelSize
    )

    Create a new IPrecompInputProbeRegion that represents a region of 3D space with voxels of the specified size.

    Parameters
    [in] voxelSize

    The size of the smallest possible voxel used to represent the region of 3D space.


    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": 13, "requestCorrelationId": "0d72ebc70dce4678884792fa7821df67"}