RigLogic::restore

Factory method for restoring an instance of [RigLogic](API\Plugins\RigLogicLib\riglogic\riglogic\RigLogic) from a memory dump. @note This form of creation allows faster instantiation of [RigLogic](API\Plugins\RigLogicLib\riglogic\riglogic\RigLogic), as it doesn't need to go through the storage optimization phase, it just loads an earlier dumped state of a [RigLogic](API\Plugins\RigLogicLib\riglogic\riglogic\RigLogic) instance back into memory.

Windows
MacOS
Linux

Warnings

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

References

Module

RigLogicLib

Header

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Public/riglogic/riglogic/RigLogic.h

Include

#include "riglogic/riglogic/RigLogic.h"

Source

/Engine/Plugins/Animation/RigLogic/Source/RigLogicLib/Private/riglogic/riglogic/RigLogicImpl.cpp

Syntax

static RigLogic * restore
(
    BoundedIOStream * source,
    MemoryResource * memRes
)

Remarks

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

Parameters

Parameter

Description

source

Source stream from which to restore the state, obtained by calling dump.

memRes

A custom memory resource to be used for allocations. @note If a custom memory resource is not given, a default allocation mechanism will be used.

See Also

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss