API Documentation
ContentLoader.h
1 // ContentLoader.h
3 //
5 
6 namespace nkGraphics
7 {
11  class ContentLoader final
12  {
13  public :
14 
15  // Constructor
21  ContentLoader (System* system) noexcept ;
22 
37  std::string inputDataStr (nkMemory::StringView filePath) ;
55 
56  // Save
73 
74  // Textures
82  ContentLoadResultTexture loadTextureDeclaration (nkMemory::StringView pathFromData, bool loadResource = true) ;
98  ContentLoadResultTexture processTextureTree (nkExport::Node* tree, bool loadResource = true) ;
99  // Samplers
107  ContentLoadResultSampler loadSamplerDeclaration (nkMemory::StringView pathFromData, bool loadResource = true) ;
123  ContentLoadResultSampler processSamplerTree (nkExport::Node* tree, bool loadResource = true) ;
124  // Shaders Program
149  // Shader Memory Slot
171  // Constant Buffer
193  // Compute Buffer
201  ContentLoadResultBuffer loadBufferDeclaration (nkMemory::StringView pathFromData, bool loadResource = true) ;
218  // Shader
226  ContentLoadResultShader loadShaderDeclaration (nkMemory::StringView pathFromData, bool loadResource = true) ;
243  // Pass
265  // Compositor
287  // Meshes
295  ContentLoadResultMesh loadMeshDeclaration (nkMemory::StringView pathFromData, bool loadResource = true) ;
303  ContentLoadResultMesh processMeshSources (nkMemory::StringView sources, bool loadResource = true) ;
311  ContentLoadResultMesh processMeshTree (nkExport::Node* tree, bool loadResource = true) ;
312  // Nodes
334  // Blend States
359  // Depth Stencil States
384  // Raster States
409  // Camera
431  // Render Queues
453 
484  } ;
485 }
nkGraphics::ContentLoader::processMeshSources
ContentLoadResultMesh processMeshSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::processBufferSources
ContentLoadResultBuffer processBufferSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::processNodeSources
ContentLoadResultNode processNodeSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::loadRasterStateDeclaration
ContentLoadResultRasterState loadRasterStateDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::System
Main interface with the component system.
Definition: System.h:14
nkGraphics::ContentLoader::processConstantBufferDeclarationTree
ContentLoadResultConstantBuffer processConstantBufferDeclarationTree(nkExport::Node *tree)
nkGraphics::ContentLoader::processShaderProgramSources
ContentLoadResultProgram processShaderProgramSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::loadCameraDeclaration
ContentLoadResultCamera loadCameraDeclaration(nkMemory::StringView pathFromData)
nkExport::Exportable
An interface to define objects that can be exported using this component.
Definition: Exportable.h:15
nkGraphics::ContentLoader::saveObjectDeclaration
bool saveObjectDeclaration(nkExport::Exportable *object, nkMemory::StringView pathFromData)
nkGraphics::Compositor
A compositor, describing how to compose the rendering pipeline.
Definition: Compositor.h:23
nkGraphics::ContentLoader::loadNodeDeclaration
ContentLoadResultNode loadNodeDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::inputData
nkExport::ExporterLoadResult inputData(nkMemory::StringView filePath)
nkGraphics::ContentLoader::processShaderProgramTree
ContentLoadResultProgram processShaderProgramTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::loadBufferDeclaration
ContentLoadResultBuffer loadBufferDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::inputDataSources
nkExport::ExporterLoadResult inputDataSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::appendCompositorNodeFromSources
ContentLoadResultCompositorNode appendCompositorNodeFromSources(nkMemory::StringView sources, Compositor *parent)
nkExport::ExporterLoadResult
Holds the information about a try to import data sources.
Definition: ExporterLoadResult.h:15
nkGraphics::ContentLoader::processSamplerSources
ContentLoadResultSampler processSamplerSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::loadDepthStencilStateDeclaration
ContentLoadResultDepthStencilState loadDepthStencilStateDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::outputData
bool outputData(nkMemory::StringView content, nkMemory::StringView path)
nkGraphics::ContentLoader::loadConstantBufferDeclaration
ContentLoadResultConstantBuffer loadConstantBufferDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::inputDataStr
std::string inputDataStr(nkMemory::StringView filePath)
nkGraphics::ContentLoader::processBufferDeclarationTree
ContentLoadResultBuffer processBufferDeclarationTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::processConstantBufferSources
ContentLoadResultConstantBuffer processConstantBufferSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::processRenderQueueSources
ContentLoadResultRenderQueue processRenderQueueSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::processMeshTree
ContentLoadResultMesh processMeshTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::ContentLoader
ContentLoader(System *system) noexcept
nkGraphics::ContentLoader::saveTreeDeclaration
bool saveTreeDeclaration(nkExport::Node *tree, nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::processSamplerTree
ContentLoadResultSampler processSamplerTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::processDepthStencilStateTree
ContentLoadResultDepthStencilState processDepthStencilStateTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::processShaderMemorySlotDeclarationTree
ContentLoadResultShaderMemorySlot processShaderMemorySlotDeclarationTree(nkExport::Node *tree)
nkExport::Node
A node in the tree structure representing the data to export / import.
Definition: Node.h:42
nkGraphics::ContentLoader::processPassTree
ContentLoadResultPass processPassTree(nkExport::Node *tree)
nkGraphics::ContentLoader::processBlendStateSources
ContentLoadResultBlendState processBlendStateSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::processCameraTree
ContentLoadResultCamera processCameraTree(nkExport::Node *tree)
nkGraphics::ContentLoader::processTextureSources
ContentLoadResultTexture processTextureSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::processCompositorSources
ContentLoadResultCompositor processCompositorSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::processShaderMemorySlotSources
ContentLoadResultShaderMemorySlot processShaderMemorySlotSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::processRenderQueueTree
ContentLoadResultRenderQueue processRenderQueueTree(nkExport::Node *tree)
nkGraphics::ContentLoader
Utility class that allows to load content through their declaration files.
Definition: ContentLoader.h:12
nkGraphics::ContentLoader::processTextureTree
ContentLoadResultTexture processTextureTree(nkExport::Node *tree, bool loadResource=true)
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::ContentLoader::processRasterStateTree
ContentLoadResultRasterState processRasterStateTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::processCompositorTree
ContentLoadResultCompositor processCompositorTree(nkExport::Node *tree)
nkGraphics::ContentLoader::processDepthStencilStateSources
ContentLoadResultDepthStencilState processDepthStencilStateSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::loadSamplerDeclaration
ContentLoadResultSampler loadSamplerDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::loadPassDeclaration
ContentLoadResultPass loadPassDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::appendCompositorNodeFromFile
ContentLoadResultCompositorNode appendCompositorNodeFromFile(nkMemory::StringView pathFromData, Compositor *parent)
nkGraphics::ContentLoader::processBlendStateTree
ContentLoadResultBlendState processBlendStateTree(nkExport::Node *tree, bool loadResource=true)
nkGraphics::ContentLoader::loadShaderDeclaration
ContentLoadResultShader loadShaderDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::appendCompositorNodeFromTree
ContentLoadResultCompositorNode appendCompositorNodeFromTree(nkExport::Node *tree, Compositor *parent)
nkGraphics::ContentLoadResult
Holds information about an attempt of parsing content declaration sources.
Definition: ContentLoadResult.h:23
nkGraphics::ContentLoader::loadShaderMemorySlotDeclaration
ContentLoadResultShaderMemorySlot loadShaderMemorySlotDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::loadMeshDeclaration
ContentLoadResultMesh loadMeshDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::processShaderDeclarationSources
ContentLoadResultShader processShaderDeclarationSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::loadBlendStateDeclaration
ContentLoadResultBlendState loadBlendStateDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::ContentLoader::processPassSources
ContentLoadResultPass processPassSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::loadShaderProgramDeclaration
ContentLoadResultProgram loadShaderProgramDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::loadRenderQueueDeclaration
ContentLoadResultRenderQueue loadRenderQueueDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::loadCompositorDeclaration
ContentLoadResultCompositor loadCompositorDeclaration(nkMemory::StringView pathFromData)
nkGraphics::ContentLoader::processCameraSources
ContentLoadResultCamera processCameraSources(nkMemory::StringView sources)
nkGraphics::ContentLoader::processRasterStateSources
ContentLoadResultRasterState processRasterStateSources(nkMemory::StringView sources, bool loadResource=true)
nkGraphics::ContentLoader::loadTextureDeclaration
ContentLoadResultTexture loadTextureDeclaration(nkMemory::StringView pathFromData, bool loadResource=true)
nkGraphics::ContentLoader::processNodeTree
ContentLoadResultNode processNodeTree(nkExport::Node *tree)
nkGraphics::ContentLoader::processShaderDeclarationTree
ContentLoadResultShader processShaderDeclarationTree(nkExport::Node *tree, bool loadResource=true)