DEKI/ENGINE docs
Deki 0.19.0
Modular C++ 2D engine for embedded displays and desktop
Loading...
Searching...
No Matches
DekiEditor::IAssetImporter Class Referenceabstract

Base interface for asset importers. More...

#include <C:/Users/kirby/Documents/Github/deki/deki-editor/deki-editor/include/deki-editor/IAssetImporter.h>

Inherited by DekiEditor::TextureImporter.

Public Member Functions

virtual ~IAssetImporter ()=default
virtual std::vector< std::string > GetSupportedExtensions () const =0
 The extensions it handles, e.g. {".png", ".jpg", ".bmp"}.
virtual std::string GetImporterName () const =0
 A name for logs.
virtual ImportResult Import (const std::string &sourcePath, const std::string &cachePath)=0
 Imports the source file into the cache.
virtual bool NeedsReimport (const std::string &sourcePath, const std::string &cachePath) const
 Whether the asset needs importing again.

Detailed Description

Base interface for asset importers.

Constructor & Destructor Documentation

◆ ~IAssetImporter()

virtual DekiEditor::IAssetImporter::~IAssetImporter ( )
virtualdefault

Member Function Documentation

◆ GetSupportedExtensions()

virtual std::vector< std::string > DekiEditor::IAssetImporter::GetSupportedExtensions ( ) const
pure virtual

The extensions it handles, e.g. {".png", ".jpg", ".bmp"}.

Implemented in DekiEditor::TextureImporter.

◆ GetImporterName()

virtual std::string DekiEditor::IAssetImporter::GetImporterName ( ) const
pure virtual

A name for logs.

Implemented in DekiEditor::TextureImporter.

◆ Import()

virtual ImportResult DekiEditor::IAssetImporter::Import ( const std::string & sourcePath,
const std::string & cachePath )
pure virtual

Imports the source file into the cache.

Implemented in DekiEditor::TextureImporter.

◆ NeedsReimport()

virtual bool DekiEditor::IAssetImporter::NeedsReimport ( const std::string & sourcePath,
const std::string & cachePath ) const
inlinevirtual

Whether the asset needs importing again.

By default, when there is no cache file.


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