Nebula
Loading...
Searching...
No Matches
material.h
Go to the documentation of this file.
1#pragma once
2//------------------------------------------------------------------------------
11//------------------------------------------------------------------------------
12#include "ids/id.h"
13#include "ids/idallocator.h"
16#include "coregraphics/buffer.h"
17#include "materialvariant.h"
18
19
21{
22struct Entry;
23enum class BatchGroup;
24};
25
27{
28struct Entry;
29enum class BatchGroup;
30};
31
32namespace Materials
33{
34
35struct ShaderConfigBatchTexture;
37ID_32_24_8_NAMED_TYPE(MaterialInstanceId, instance, materialId, materialGeneration, material); // 32 bits instance, 24 bits material, 8 bits type
38
40
42{
43 Graphics = 0x1, // Bindless material buffers needs a graphics queue update
44 Compute = 0x2, // Bindless material buffers needs a compute queue update
46};
47
48#ifdef WITH_NEBULA_EDITOR
49struct MaterialBindlessBufferBinding
50{
51 char* buffer = nullptr;
52 bool* dirtyFlag = nullptr;
53};
54#endif
55
57MaterialId CreateMaterial(const MaterialTemplatesGPULang::Entry* entry);
59void DestroyMaterial(const MaterialId id);
60
62void MaterialSetTexture(const MaterialId mat, const ShaderConfigBatchTexture* bind, const Resources::ResourceId tex);
64void MaterialSetTexture(const MaterialId mat, uint name, const Resources::ResourceId tex);
66void MaterialSetTextureBindless(const MaterialId mat, uint name, const uint handle, const uint offset, const Resources::ResourceId tex);
68void MaterialSetConstants(const MaterialId mat, const void* data, const uint size);
70void MaterialSetConstant(const MaterialId mat, const void* data, const uint size, const uint offset);
71
73void MaterialSetBufferBinding(const MaterialId id, IndexT index);
76
77
79void MaterialAddLODTexture(const MaterialId mat, const Resources::ResourceId tex);
81void MaterialSetLowestLod(const MaterialId mat, float lod);
82
84void MaterialApply(const MaterialId id, const CoreGraphics::CmdBufferId buf, IndexT index);
85
87const MaterialTemplatesGPULang::Entry* MaterialGetTemplate(const MaterialId mat);
89const Materials::BatchIndex MaterialGetBatchIndex(const MaterialId mat, const MaterialTemplatesGPULang::BatchGroup batch);
91uint64_t MaterialGetSortCode(const MaterialId mat);
92
93#ifdef WITH_NEBULA_EDITOR
95void MaterialBindlessForEditor(const MaterialId mat, char* buf, bool* dirtyFlag);
97const MaterialBindlessBufferBinding& MaterialGetBindlessForEditor(const MaterialId mat);
99ubyte* MaterialGetConstants(const MaterialId mat);
101const Resources::ResourceId MaterialGetTexture(const MaterialId mat, const IndexT i);
103void MaterialInvalidate(const MaterialId mat);
104#endif
105
119
125
126enum
127{
138#ifdef WITH_NEBULA_EDITOR
139 , Material_TextureValues
140 , Material_BufferPointer
141#endif
142};
143
144
145typedef Ids::IdAllocator<
146 float,
148 Util::FixedArray<CoreGraphics::ResourceTableId>, // surface level resource table, mapped batch -> table
149 CoreGraphics::BufferId, // Material buffer
150 Util::FixedArray<Util::FixedArray<CoreGraphics::ResourceTableId>>, // instance level resource table, mapped batch -> table
151 Util::FixedArray<Util::Tuple<IndexT, SizeT>>, // instance level instance buffer, mapped batch -> memory + size
154 IndexT, // global material buffer binding (based on ShaderConfig::PrototypeHash)
155 const MaterialTemplatesGPULang::Entry* // template
156#ifdef WITH_NEBULA_EDITOR
158 , MaterialBindlessBufferBinding
159#endif
162
166void DestroyMaterialInstance(const MaterialInstanceId materialInstance);
167
171void MaterialInstanceApply(const MaterialInstanceId id, const CoreGraphics::CmdBufferId buf, IndexT index, IndexT bufferIndex);
172
173
176
181typedef Ids::IdAllocator<
182 uint
185
186} // namespace Materials
An ID allocator associates an id with a slice in an N number of arrays.
Definition idallocator.h:39
Nebula's dynamic array class.
Definition array.h:60
Implements a fixed size one-dimensional array.
Definition fixedarray.h:20
#define ID_32_24_8_NAMED_TYPE(x, id32_name, id24_name, id8_name, combined_name)
Definition id.h:46
Acceleration structures are used to enable ray tracing on the GPU by dividing the scene into a BVH.
Definition accelerationstructure.h:24
uint64_t ConstantBufferOffset
Definition config.h:21
Implements the shader server used by Vulkan.
Definition cameramanager.h:21
Definition material.h:27
Materials represent a set of settings and a correlated shader configuration, which tells the engine w...
Definition material.h:21
Material special version of variant.
Definition material.cc:12
void DestroyMaterial(const MaterialId id)
Destroy material.
Definition material.cc:160
const Materials::BatchIndex MaterialGetBatchIndex(const MaterialId mat, const MaterialTemplatesGPULang::BatchGroup batch)
Get batch index from code.
Definition material.cc:322
void DestroyMaterialInstance(const MaterialInstanceId materialInstance)
Destroy material instance.
Definition material.cc:413
void MaterialApply(const MaterialId id, const CoreGraphics::CmdBufferId buf, IndexT index)
Apply material.
Definition material.cc:389
Ids::IdAllocator< float, Util::Array< Resources::ResourceId >, Util::FixedArray< CoreGraphics::ResourceTableId >, CoreGraphics::BufferId, Util::FixedArray< Util::FixedArray< CoreGraphics::ResourceTableId > >, Util::FixedArray< Util::Tuple< IndexT, SizeT > >, Util::FixedArray< Util::Array< MaterialTexture > >, Util::FixedArray< Util::Array< MaterialConstant > >, IndexT, const MaterialTemplatesGPULang::Entry * > MaterialAllocator
Definition material.h:160
const MaterialTemplatesGPULang::Entry * MaterialGetTemplate(const MaterialId mat)
Get material shader config.
Definition material.cc:313
void MaterialSetConstant(const MaterialId mat, const void *data, const uint size, const uint offset)
Set a material constant.
Definition material.cc:252
void MaterialInstanceApply(const MaterialInstanceId id, const CoreGraphics::CmdBufferId buf, IndexT index, IndexT bufferIndex)
Apply material instance.
Definition material.cc:436
Ids::IdAllocator< uint > MaterialInstanceAllocator
Definition material.h:183
MaterialInstanceMembers
Definition material.h:178
@ MaterialInstance_Offsets
Definition material.h:179
IndexT MaterialGetBufferBinding(const MaterialId id)
Get material GPU buffer binding.
Definition material.cc:272
uint64_t MaterialGetSortCode(const MaterialId mat)
Get sort code.
Definition material.cc:331
void MaterialSetTextureBindless(const MaterialId mat, uint name, const uint handle, const uint offset, const Resources::ResourceId tex)
Set bindless texture.
Definition material.cc:215
MaterialId CreateMaterial(const MaterialTemplatesGPULang::Entry *entry)
Create material.
Definition material.cc:22
void MaterialAddLODTexture(const MaterialId mat, const Resources::ResourceId tex)
Add texture to LOD update.
Definition material.cc:281
SizeT MaterialInstanceBufferSize(const MaterialInstanceId mat, const BatchIndex batch)
Get material instance buffer size for batch.
Definition material.cc:455
@ Material_InstanceTables
Definition material.h:132
@ Material_Textures
Definition material.h:134
@ Material_MinLOD
Definition material.h:128
@ Material_Buffer
Definition material.h:131
@ Material_BufferOffset
Definition material.h:136
@ Material_Constants
Definition material.h:135
@ Material_LODTextures
Definition material.h:129
@ Material_Template
Definition material.h:137
@ Material_Table
Definition material.h:130
@ Material_InstanceBuffers
Definition material.h:133
MaterialAllocator materialAllocator
Definition material.cc:14
void MaterialSetBufferBinding(const MaterialId id, IndexT index)
Set material GPU buffer binding.
Definition material.cc:263
MaterialInstanceAllocator materialInstanceAllocator
Definition material.cc:15
void MaterialSetLowestLod(const MaterialId mat, float lod)
Update LOD for material.
Definition material.cc:294
IndexT BatchIndex
Definition material.h:39
CoreGraphics::ConstantBufferOffset MaterialInstanceAllocate(const MaterialInstanceId mat, const BatchIndex batch)
Allocate instance constants, call per frame when instance constants are needed.
Definition material.cc:422
BindlessBufferDirtyBits
Definition material.h:42
@ Compute
Definition material.h:44
@ All
Definition material.h:45
void MaterialSetTexture(const MaterialId mat, const ShaderConfigBatchTexture *bind, const Resources::ResourceId tex)
Set texture.
Definition material.cc:169
material
Definition material.h:37
MaterialInstanceId CreateMaterialInstance(const MaterialId material)
Create material instance.
Definition material.cc:398
void MaterialSetConstants(const MaterialId mat, const void *data, const uint size)
Set all material constants.
Definition material.cc:233
#define RESOURCE_ID_TYPE(type)
Definition resourceid.h:41
Definition buffer.h:23
Definition commandbuffer.h:168
texture type
Definition texture.h:25
Definition materialtemplatetypes.h:67
Definition materialtemplatetypes.h:153
IndexT binding
Definition material.h:111
MaterialVariant defaultValue
Definition material.h:108
CoreGraphics::BufferId buffer
Definition material.h:112
MaterialConstant()
Definition material.h:114
bool instanceConstant
Definition material.h:110
IndexT bufferIndex
Definition material.h:109
Definition material.h:36
Definition material.h:37
Definition material.h:121
CoreGraphics::TextureId defaultValue
Definition material.h:122
IndexT slot
Definition material.h:123
Definition materialvariant.h:15
Definition shaderconfig.h:34
unsigned char ubyte
Definition types.h:36
int SizeT
Definition types.h:42
unsigned int uint
Definition types.h:33
int IndexT
Definition types.h:41