package asset_importer

import "kaiju/engine/assets/asset_importer"

Variables

ErrNoImporter

errors.New("no importer found for file")

MetaOptions

map[string]any{

Types

GlbImporter

struct

type GlbImporter struct{}

GlbImporter.Handles

func (m GlbImporter) Handles(path string) bool

GlbImporter.Import

func (m GlbImporter) Import(path string) error

GlbImporter.MetadataStructure

func (m GlbImporter) MetadataStructure() any

GltfImporter

struct

type GltfImporter struct{}

GltfImporter.Handles

func (m GltfImporter) Handles(path string) bool

GltfImporter.Import

func (m GltfImporter) Import(path string) error

GltfImporter.MetadataStructure

func (m GltfImporter) MetadataStructure() any

HtmlImporter

struct

type HtmlImporter struct{}

HtmlImporter.Handles

func (m HtmlImporter) Handles(path string) bool

HtmlImporter.Import

func (m HtmlImporter) Import(path string) error

HtmlImporter.MetadataStructure

func (m HtmlImporter) MetadataStructure() any

HtmlMetadata

struct

type HtmlMetadata struct{}

ImageMetadata

struct

type ImageMetadata struct {
    Filter        string `options:"imageFilterOptions"`
    Pivot         string `options:"imagePivot"`
    PixelsPerUnit int32
    Mipmaps       int32

    // TODO:  This needs to be used for packaging the content
    MaxSize string `options:"imageMaxSize"`
}

ImageMetadata.ImageFilterMeta

func (m *ImageMetadata) ImageFilterMeta() rendering.TextureFilter

ImageMetadata.ImagePivotMeta

func (m *ImageMetadata) ImagePivotMeta() rendering.QuadPivot

ImageMetadata.MaxSizeMeta

func (m *ImageMetadata) MaxSizeMeta() int32

ImportRegistry

struct

type ImportRegistry struct {
    // Has unexported fields.
}

NewImportRegistry

func NewImportRegistry() ImportRegistry

ImportRegistry.Import

func (r *ImportRegistry) Import(path string) error

ImportRegistry.ImportIfNew

func (r *ImportRegistry) ImportIfNew(path string) error

ImportRegistry.ImportUsingDefault

func (r *ImportRegistry) ImportUsingDefault(path string) error

ImportRegistry.MetadataStructure

func (r *ImportRegistry) MetadataStructure(path string) any

ImportRegistry.Register

func (r *ImportRegistry) Register(importer Importer)

ImportType

string

type ImportType = string

Importer

interface

type Importer interface {
    Handles(path string) bool
    Import(path string) error
    MetadataStructure() any
}

Importer is an interface for importing assets into the asset database. It is used to allow for custom importers to be added to the system to handle new asset types. Handles should return true if the importer can handle the given path. Import should import the asset into the asset database.

MaterialImporter

struct

type MaterialImporter struct{}

MaterialImporter.Handles

func (m MaterialImporter) Handles(path string) bool

MaterialImporter.Import

func (m MaterialImporter) Import(path string) error

MaterialImporter.MetadataStructure

func (m MaterialImporter) MetadataStructure() any

MaterialMetadata

struct

type MaterialMetadata struct{}

MeshMetadata

struct

type MeshMetadata struct {
    Name     string
    Material string
}

ObjImporter

struct

type ObjImporter struct{}

ObjImporter.Handles

func (m ObjImporter) Handles(path string) bool

ObjImporter.Import

func (m ObjImporter) Import(path string) error

ObjImporter.MetadataStructure

func (m ObjImporter) MetadataStructure() any

PngImporter

struct

type PngImporter struct{}

PngImporter.Handles

func (m PngImporter) Handles(path string) bool

PngImporter.Import

func (m PngImporter) Import(path string) error

PngImporter.MetadataStructure

func (m PngImporter) MetadataStructure() any

RenderPassImporter

struct

type RenderPassImporter struct{}

RenderPassImporter.Handles

func (m RenderPassImporter) Handles(path string) bool

RenderPassImporter.Import

func (m RenderPassImporter) Import(path string) error

RenderPassImporter.MetadataStructure

func (m RenderPassImporter) MetadataStructure() any

RenderPassMetadata

struct

type RenderPassMetadata struct{}

ShaderImporter

struct

type ShaderImporter struct{}

ShaderImporter.Handles

func (m ShaderImporter) Handles(path string) bool

ShaderImporter.Import

func (m ShaderImporter) Import(path string) error

ShaderImporter.MetadataStructure

func (m ShaderImporter) MetadataStructure() any

ShaderMetadata

struct

type ShaderMetadata struct{}

ShaderPipelineImporter

struct

type ShaderPipelineImporter struct{}

ShaderPipelineImporter.Handles

func (m ShaderPipelineImporter) Handles(path string) bool

ShaderPipelineImporter.Import

func (m ShaderPipelineImporter) Import(path string) error

ShaderPipelineImporter.MetadataStructure

func (m ShaderPipelineImporter) MetadataStructure() any

ShaderPipelineMetadata

struct

type ShaderPipelineMetadata struct{}

StageImporter

struct

type StageImporter struct{}

StageImporter.Handles

func (m StageImporter) Handles(path string) bool

StageImporter.Import

func (m StageImporter) Import(path string) error

StageImporter.MetadataStructure

func (m StageImporter) MetadataStructure() any

StageMetadata

struct

type StageMetadata struct{}