Berserk
Public Member Functions | List of all members
ResourceImporter Class Referenceabstract

Base class responsible for importing a specific resource type. More...

#include <ResourceImporter.hpp>

Inheritance diagram for ResourceImporter:
Inheritance graph
[legend]

Public Member Functions

virtual BRK_API ~ResourceImporter ()=default
 
virtual BRK_API Ref< ResourceImportOptionsCreateDefaultOptions () const =0
 Creates default importer options for import. More...
 
virtual BRK_API const std::vector< String > & GetSupportedExtensions () const =0
 Get list of supported file extensions for import. More...
 
virtual BRK_API void Import (const String &fullpath, const Ref< ResourceImportOptions > &options, ResourceImportResult &result)=0
 Imports resource or set of resources. More...
 

Detailed Description

Base class responsible for importing a specific resource type.

Constructor & Destructor Documentation

◆ ~ResourceImporter()

virtual BRK_API ResourceImporter::~ResourceImporter ( )
virtualdefault

Member Function Documentation

◆ CreateDefaultOptions()

virtual BRK_API Ref<ResourceImportOptions> ResourceImporter::CreateDefaultOptions ( ) const
pure virtual

Creates default importer options for import.

Returns
Options

Implemented in ImporterTexture, ImporterShader, and ImporterMesh.

◆ GetSupportedExtensions()

virtual BRK_API const std::vector<String>& ResourceImporter::GetSupportedExtensions ( ) const
pure virtual

Get list of supported file extensions for import.

Returns
List of extensions

Implemented in ImporterTexture, ImporterShader, and ImporterMesh.

◆ Import()

virtual BRK_API void ResourceImporter::Import ( const String fullpath,
const Ref< ResourceImportOptions > &  options,
ResourceImportResult result 
)
pure virtual

Imports resource or set of resources.

Parameters
[in]fullpathFull path to the resource on the disc
[in]optionsOptions used to import resource
[out]resultResult of the import operation

Implemented in ImporterTexture, ImporterShader, and ImporterMesh.


The documentation for this class was generated from the following file: