Search Results for

    Show / Hide Table of Contents

    Class BinaryAssetFactoryBase

    The binary assets factory base class.

    Inheritance
    IAssetFactory
    BinaryAssetFactoryBase
    Inherited Members
    BinaryAssetFactoryBase
    IAssetFactory::Get()
    IAssetFactory::GetUpgrader()
    IAssetFactory::SupportsVirtualAssets()
    IAssetFactory::~IAssetFactory()
    Assembly: FlaxEngine.dll
    File: Engine/Content/Factories/BinaryAssetFactory.h
    Syntax
    public class BinaryAssetFactoryBase : public IAssetFactory

    Methods

    Create(const AssetInfo& info)

    Declaration
    protected virtual BinaryAsset* Create(const AssetInfo& info) = 0
    Parameters
    AssetInfo info

    Returns
    BinaryAsset

    Init(BinaryAsset* asset)

    Initializes the specified asset. It's called in background before actual asset loading.

    Declaration
    public bool Init(BinaryAsset* asset)
    Parameters
    BinaryAsset asset

    The asset.

    Returns
    bool

    True if failed, otherwise false.

    IsVersionSupported(uint32 serializedVersion)

    Declaration
    protected virtual bool IsVersionSupported(uint32 serializedVersion) const = 0
    Parameters
    uint32 serializedVersion

    Returns
    bool

    New(const AssetInfo& info)

    Creates new asset instance.

    Declaration
    public virtual Asset* New(const AssetInfo& info) override
    Parameters
    AssetInfo info

    The asset info structure.

    Returns
    Asset

    Created asset object.

    Overrides
    IAssetFactory::New(const AssetInfo& info)

    NewVirtual(const AssetInfo& info)

    Creates new virtual asset instance. Virtual assets are temporary and exist until application exit.

    Declaration
    public virtual Asset* NewVirtual(const AssetInfo& info) override
    Parameters
    AssetInfo info

    The asset info structure.

    Returns
    Asset

    Created asset object.

    Overrides
    IAssetFactory::NewVirtual(const AssetInfo& info)

    UpgradeAsset(const AssetInfo& info, FlaxStorage* storage, AssetMigrationContext& context)

    Declaration
    protected bool UpgradeAsset(const AssetInfo& info, FlaxStorage* storage, AssetMigrationContext& context)
    Parameters
    AssetInfo info

    FlaxStorage storage

    AssetMigrationContext context

    Returns
    bool

    See Also

    IAssetFactory
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat