ToyMaker::TextureFromFile Class Reference

A resource constructor which loads a texture from a supported image file located via its file path. More...

#include <texture.hpp>

Inheritance diagram for ToyMaker::TextureFromFile:

Static Public Member Functions
static std::string	getResourceConstructorName ()

Private Member Functions
std::shared_ptr< IResource >	createResource (const nlohmann::json &methodParameters) override
	Creates a resource object using the parameters specified in methodParameters.

Additional Inherited Members
Public Member Functions inherited from ToyMaker::ResourceConstructor< Texture, TextureFromFile >
std::string	getResourceConstructorName_ () const override
	Gets the resource constructor type string of the constructor.
Public Member Functions inherited from ToyMaker::IResourceConstructor
virtual	~IResourceConstructor ()=default
	Destroys this resource constructor (when the application is terminated.)
Protected Member Functions inherited from ToyMaker::ResourceConstructor< Texture, TextureFromFile >
	ResourceConstructor (int explicitlyInitializeMe)
	Construct a new ResourceConstructor object.
Protected Member Functions inherited from ToyMaker::IResourceConstructor
	IResourceConstructor ()=default
	Construct a new IResourceConstructor object.
Static Protected Member Functions inherited from ToyMaker::IResourceConstructor
template<typename TResource, typename TResourceConstructor>
static void	RegisterResourceConstructor ()
	Registers this resource constructor against its respective ResourceFactory during static initialization.

Detailed Description

A resource constructor which loads a texture from a supported image file located via its file path.

Usage:

An example JSON texture resource description.

{
    "name": "Skybox_Texture",
    "type": "Texture",
    "method": "fromFile",
    "parameters": {
        "path": "data/textures/skybox.png",
        "cubemap_layout": "row"
    }
}

Member Function Documentation

createResource()

std::shared_ptr< IResource > TextureFromFile::createResource ( const nlohmann::json & methodParameters )

overrideprivatevirtual

Creates a resource object using the parameters specified in methodParameters.

Parameters

methodParameters

The parameters used to construct an object via this constructor.

Returns

std::shared_ptr<IResource> A reference to the created resource.

Implements ToyMaker::IResourceConstructor.

---

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

• src/engine/texture.hpp
• src/engine/texture.cpp