create

Navigation

API > API/Plugins > API/Plugins/RigLogicLib > API/Plugins/RigLogicLib/BinaryStreamReader

Overloads

create(BoundedIOStream , DataLayer, UnknownLayerPolicy, std::uint16_t, MemoryResource )

Warnings The maxLOD value must be less than the value returned by getLODCount. User is responsible for releasing the returned pointer by calling destroy.

Description

The Definition data layer depends on and thus implicitly loads the Descriptor layer. The Behavior data layer depends on and thus implicitly loads the Definition layer. The Geometry data layer depends on and thus also implicitly loads the Definition layer. The MachineLearnedBehavior data layer depends on and thus also implicitly loads the Definition layer.

A value of zero indicates to load all LODs.

The maxLOD value must be less than the value returned by getLODCount.

If a memory resource is not given, a default allocation mechanism will be used.

User is responsible for releasing the returned pointer by calling destroy.

static BinaryStreamReader * create  
(  
    BoundedIOStream * stream,  
    DataLayer layer,  
    UnknownLayerPolicy policy,  
    std::uint16_t maxLOD,  
    MemoryResource * memRes  
)  
Copy full snippet

static BinaryStreamReader * create (     BoundedIOStream * stream,     DataLayer layer,     UnknownLayerPolicy policy,     std::uint16_t maxLOD,     MemoryResource * memRes )

Parameters

See Also

• getLODCount

• destroy

create(BoundedIOStream , DataLayer, UnknownLayerPolicy, std::uint16_t, std::uint16_t, MemoryResource )

Warnings Both maxLOD and minLOD values must be less than the value returned by getLODCount. User is responsible for releasing the returned pointer by calling destroy.

Description

The Definition data layer depends on and thus implicitly loads the Descriptor layer. The Behavior data layer depends on and thus implicitly loads the Definition layer. The Geometry data layer depends on and thus also implicitly loads the Definition layer. The MachineLearnedBehavior data layer depends on and thus also implicitly loads the Definition layer.

A range of [0, LOD count - 1] for maxLOD / minLOD respectively indicates to load all LODs.

Both maxLOD and minLOD values must be less than the value returned by getLODCount.

If a memory resource is not given, a default allocation mechanism will be used.

User is responsible for releasing the returned pointer by calling destroy.

static BinaryStreamReader * create  
(  
    BoundedIOStream * stream,  
    DataLayer layer,  
    UnknownLayerPolicy policy,  
    std::uint16_t maxLOD,  
    std::uint16_t minLOD,  
    MemoryResource * memRes  
)  
Copy full snippet

static BinaryStreamReader * create (     BoundedIOStream * stream,     DataLayer layer,     UnknownLayerPolicy policy,     std::uint16_t maxLOD,     std::uint16_t minLOD,     MemoryResource * memRes )

Parameters

See Also

• getLODCount

• destroy

create(BoundedIOStream , DataLayer, UnknownLayerPolicy, std::uint16_t , std::uint16_t, MemoryResource *)

Warnings All values in the array must be less than the value returned by getLODCount. There cannot be more elements in the array than the value returned by getLODCount. * User is responsible for releasing the returned pointer by calling destroy.

Description

The Definition data layer depends on and thus implicitly loads the Descriptor layer. The Behavior data layer depends on and thus implicitly loads the Definition layer. The Geometry data layer depends on and thus also implicitly loads the Definition layer. The MachineLearnedBehavior data layer depends on and thus also implicitly loads the Definition layer.

All values in the array must be less than the value returned by getLODCount.

There cannot be more elements in the array than the value returned by getLODCount.

If a memory resource is not given, a default allocation mechanism will be used.

User is responsible for releasing the returned pointer by calling destroy.

static BinaryStreamReader * create  
(  
    BoundedIOStream * stream,  
    DataLayer layer,  
    UnknownLayerPolicy policy,  
    std::uint16_t * lods,  
    std::uint16_t lodCount,  
    MemoryResource * memRes  
)  
Copy full snippet

static BinaryStreamReader * create (     BoundedIOStream * stream,     DataLayer layer,     UnknownLayerPolicy policy,     std::uint16_t * lods,     std::uint16_t lodCount,     MemoryResource * memRes )

Parameters

See Also

• getLODCount

• getLODCount

• destroy