-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathmaterial_class.cpp
1846 lines (1661 loc) · 68.4 KB
/
material_class.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (C) 2020-2024 Sami Väisänen
// Copyright (C) 2020-2024 Ensisoft http://www.ensisoft.com
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
#include "config.h"
#include <set>
#include "base/logging.h"
#include "base/format.h"
#include "base/hash.h"
#include "data/reader.h"
#include "data/writer.h"
#include "graphics/program.h"
#include "graphics/shader_source.h"
#include "graphics/material_class.h"
#include "graphics/texture_source.h"
#include "graphics/texture_texture_source.h"
#include "graphics/texture_file_source.h"
#include "graphics/texture_bitmap_buffer_source.h"
#include "graphics/texture_bitmap_generator_source.h"
#include "graphics/texture_text_buffer_source.h"
#include "graphics/packer.h"
#include "graphics/loader.h"
#include "graphics/enum.h"
namespace {
enum class BasicLightMaterialMap : int {
Diffuse = 0x1, Specular = 0x2, Normal = 0x4
};
} // namesapce
namespace gfx
{
MaterialClass::MaterialClass(Type type, std::string id)
: mClassId(std::move(id))
, mType(type)
{
mFlags.set(Flags::BlendFrames, true);
mFlags.set(Flags::EnableBloom, true);
}
MaterialClass::MaterialClass(const MaterialClass& other, bool copy)
{
mClassId = copy ? other.mClassId : base::RandomString(10);
mName = other.mName;
mType = other.mType;
mFlags = other.mFlags;
mShaderUri = other.mShaderUri;
mShaderSrc = other.mShaderSrc;
mActiveTextureMap = other.mActiveTextureMap;
mSurfaceType = other.mSurfaceType;
mTextureMinFilter = other.mTextureMinFilter;
mTextureMagFilter = other.mTextureMagFilter;
mTextureWrapX = other.mTextureWrapX;
mTextureWrapY = other.mTextureWrapY;
mUniforms = other.mUniforms;
for (const auto& src : other.mTextureMaps)
{
auto map = copy ? src->Copy() : src->Clone();
if (src->GetId() == other.mActiveTextureMap)
{
mActiveTextureMap = map->GetId();
}
mTextureMaps.push_back(std::move(map));
}
}
MaterialClass::MaterialClass(MaterialClass&& other) noexcept
{
mClassId = std::move(other.mClassId);
mName = std::move(other.mName);
mType = other.mType;
mFlags = other.mFlags;
mShaderUri = std::move(other.mShaderUri);
mShaderSrc = std::move(other.mShaderSrc);
mActiveTextureMap = std::move(other.mActiveTextureMap);
mSurfaceType = other.mSurfaceType;
mTextureMinFilter = other.mTextureMinFilter;
mTextureMagFilter = other.mTextureMagFilter;
mTextureWrapX = other.mTextureWrapX;
mTextureWrapY = other.mTextureWrapY;
mUniforms = std::move(other.mUniforms);
mTextureMaps = std::move(other.mTextureMaps);
}
MaterialClass::~MaterialClass() = default;
std::string MaterialClass::GetShaderName(const State& state) const noexcept
{
if (mType == Type::Custom)
return mName;
if (IsStatic())
return mName;
return base::FormatString("%1 Shader", mType);
}
std::string MaterialClass::GetShaderId(const State& state) const noexcept
{
size_t hash = 0;
hash = base::hash_combine(hash, mType);
hash = base::hash_combine(hash, mShaderSrc);
hash = base::hash_combine(hash, mShaderUri);
hash = base::hash_combine(hash, state.draw_primitive);
hash = base::hash_combine(hash, state.draw_category);
if (mType == Type::Color)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetBaseColor());
}
}
else if (mType == Type::Gradient)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor0));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor1));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor2));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor3));
hash = base::hash_combine(hash, GetGradientWeight());
hash = base::hash_combine(hash, mSurfaceType);
}
}
else if (mType == Type::Sprite)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetBaseColor());
hash = base::hash_combine(hash, GetTextureScale());
hash = base::hash_combine(hash, GetTextureVelocity());
hash = base::hash_combine(hash, GetTextureRotation());
hash = base::hash_combine(hash, GetAlphaCutoff());
hash = base::hash_combine(hash, mSurfaceType);
}
}
else if (mType == Type::Texture)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetBaseColor());
hash = base::hash_combine(hash, GetTextureScale());
hash = base::hash_combine(hash, GetTextureVelocity());
hash = base::hash_combine(hash, GetTextureRotation());
hash = base::hash_combine(hash, GetAlphaCutoff());
hash = base::hash_combine(hash, mSurfaceType);
}
}
else if (mType == Type::Tilemap)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetBaseColor());
hash = base::hash_combine(hash, GetAlphaCutoff());
hash = base::hash_combine(hash, GetTileSize());
hash = base::hash_combine(hash, GetTileOffset());
hash = base::hash_combine(hash, mSurfaceType);
}
}
else if (mType == Type::Particle2D)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetParticleStartColor());
hash = base::hash_combine(hash, GetParticleEndColor());
hash = base::hash_combine(hash, GetParticleBaseRotation());
hash = base::hash_combine(hash, mSurfaceType);
}
}
else if (mType == Type::BasicLight)
{
if (IsStatic())
{
hash = base::hash_combine(hash, GetAmbientColor());
hash = base::hash_combine(hash, GetDiffuseColor());
hash = base::hash_combine(hash, GetSpecularColor());
hash = base::hash_combine(hash, GetSpecularExponent());
}
}
else if (mType == Type::Custom)
{
// todo: static uniform information
} else BUG("Unknown material type.");
return base::FormatString("%1+%2", mType, hash);
}
std::size_t MaterialClass::GetHash() const noexcept
{
size_t hash = 0;
hash = base::hash_combine(hash, mClassId);
hash = base::hash_combine(hash, mName);
hash = base::hash_combine(hash, mType);
hash = base::hash_combine(hash, mShaderUri);
hash = base::hash_combine(hash, mShaderSrc);
hash = base::hash_combine(hash, mActiveTextureMap);
hash = base::hash_combine(hash, mSurfaceType);
hash = base::hash_combine(hash, mTextureMinFilter);
hash = base::hash_combine(hash, mTextureMagFilter);
hash = base::hash_combine(hash, mTextureWrapX);
hash = base::hash_combine(hash, mTextureWrapY);
hash = base::hash_combine(hash, mFlags);
hash = base::hash_combine(hash, GetTextureRotation());
hash = base::hash_combine(hash, GetTextureScale());
hash = base::hash_combine(hash, GetTextureVelocity());
hash = base::hash_combine(hash, GetColor(ColorIndex::BaseColor));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor0));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor1));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor2));
hash = base::hash_combine(hash, GetColor(ColorIndex::GradientColor3));
hash = base::hash_combine(hash, GetGradientWeight());
hash = base::hash_combine(hash, GetAlphaCutoff());
hash = base::hash_combine(hash, GetTileSize());
hash = base::hash_combine(hash, GetTileOffset());
hash = base::hash_combine(hash, GetParticleStartColor());
hash = base::hash_combine(hash, GetParticleEndColor());
hash = base::hash_combine(hash, GetParticleRotation());
hash = base::hash_combine(hash, GetParticleBaseRotation());
hash = base::hash_combine(hash, GetAmbientColor());
hash = base::hash_combine(hash, GetDiffuseColor());
hash = base::hash_combine(hash, GetSpecularColor());
hash = base::hash_combine(hash, GetSpecularExponent());
// remember that the order of uniforms (and texturemaps)
// can change between IntoJson/FromJson! This can result
// in a different order of items in the *unordered* maps !
// This then can result in a different hash value being
// computed. To avoid this non-sense problem use a set
// to give a consistent iteration order over the uniforms
// and texture maps.
std::set<std::string> keys;
for (const auto& uniform : mUniforms)
keys.insert(uniform.first);
for (const auto& key : keys)
{
const auto* uniform = base::SafeFind(mUniforms, key);
hash = base::hash_combine(hash, key);
hash = base::hash_combine(hash, *uniform);
}
for (const auto& map : mTextureMaps)
{
hash = base::hash_combine(hash, map->GetHash());
}
return hash;
}
ShaderSource MaterialClass::GetShader(const State& state, const Device& device) const noexcept
{
auto source = GetShaderSource(state, device);
if (source.IsEmpty())
return source;
if (!source.HasShaderBlock("PI", ShaderSource::ShaderBlockType::PreprocessorDefine))
source.AddPreprocessorDefinition("PI", "3.1415926");
source.AddPreprocessorDefinition("MATERIAL_SURFACE_TYPE_OPAQUE", static_cast<unsigned>(SurfaceType::Opaque));
source.AddPreprocessorDefinition("MATERIAL_SURFACE_TYPE_TRANSPARENT", static_cast<unsigned>(SurfaceType::Transparent));
source.AddPreprocessorDefinition("MATERIAL_SURFACE_TYPE_EMISSIVE", static_cast<unsigned>(SurfaceType::Emissive));
source.AddPreprocessorDefinition("TEXTURE_WRAP_CLAMP", static_cast<int>(TextureWrapping::Clamp));
source.AddPreprocessorDefinition("TEXTURE_WRAP_REPEAT", static_cast<int>(TextureWrapping::Repeat));
source.AddPreprocessorDefinition("TEXTURE_WRAP_MIRROR", static_cast<int>(TextureWrapping::Mirror));
source.AddPreprocessorDefinition("MATERIAL_FLAGS_ENABLE_BLOOM", static_cast<unsigned>(MaterialFlags::EnableBloom));
if (IsBuiltIn())
{
source.AddPreprocessorDefinition("PARTICLE_EFFECT_NONE", static_cast<int>(ParticleEffect::None));
source.AddPreprocessorDefinition("PARTICLE_EFFECT_ROTATE", static_cast<int>(ParticleEffect::Rotate));
if (mType == Type::Particle2D)
{
source.AddPreprocessorDefinition("PARTICLE_ROTATION_NONE", static_cast<unsigned>(ParticleRotation::None));
source.AddPreprocessorDefinition("PARTICLE_ROTATION_BASE", static_cast<unsigned>(ParticleRotation::BaseRotation));
source.AddPreprocessorDefinition("PARTICLE_ROTATION_RANDOM", static_cast<unsigned>(ParticleRotation::RandomRotation));
source.AddPreprocessorDefinition("PARTICLE_ROTATION_DIRECTION", static_cast<unsigned>(ParticleRotation::ParticleDirection));
source.AddPreprocessorDefinition("PARTICLE_ROTATION_DIRECTION_AND_BASE", static_cast<unsigned>(ParticleRotation::ParticleDirectionAndBase));
}
else if (mType == Type::BasicLight)
{
source.AddPreprocessorDefinition("BASIC_LIGHT_MATERIAL_DIFFUSE_MAP", static_cast<unsigned>(BasicLightMaterialMap::Diffuse));
source.AddPreprocessorDefinition("BASIC_LIGHT_MATERIAL_SPECULAR_MAP", static_cast<unsigned>(BasicLightMaterialMap::Specular));
source.AddPreprocessorDefinition("BASIC_LIGHT_MATERIAL_NORMAL_MAP", static_cast<unsigned>(BasicLightMaterialMap::Normal));
}
else if (mType == Type::Gradient)
{
source.AddPreprocessorDefinition("GRADIENT_TYPE_BILINEAR", static_cast<unsigned>(GradientType::Bilinear));
source.AddPreprocessorDefinition("GRADIENT_TYPE_RADIAL", static_cast<unsigned>(GradientType::Radial));
source.AddPreprocessorDefinition("GRADIENT_TYPE_CONICAL", static_cast<unsigned>(GradientType::Conical));
}
}
if (state.draw_primitive == DrawPrimitive::Triangles)
source.AddPreprocessorDefinition("DRAW_TRIANGLES");
else if (state.draw_primitive == DrawPrimitive::Points)
source.AddPreprocessorDefinition("DRAW_POINTS");
else if (state.draw_primitive == DrawPrimitive::Lines)
source.AddPreprocessorDefinition("DRAW_LINES");
else BUG("Bug on draw primitive");
if (state.draw_category == DrawCategory::Particles)
source.AddPreprocessorDefinition("GEOMETRY_IS_PARTICLES");
else if (state.draw_category == DrawCategory::TileBatch)
source.AddPreprocessorDefinition("GEOMETRY_IS_TILES");
else if (state.draw_category == DrawCategory::Basic)
source.AddPreprocessorDefinition("GEOMETRY_IS_BASIC");
else BUG("Bug on draw category");
if (IsStatic())
{
source.AddPreprocessorDefinition("STATIC_SHADER_SOURCE");
if (mSurfaceType == SurfaceType::Transparent)
source.AddPreprocessorDefinition("TRANSPARENT_SURFACE");
else if (mSurfaceType == SurfaceType::Opaque)
source.AddPreprocessorDefinition("OPAQUE_SURFACE");
else if (mSurfaceType == SurfaceType::Emissive)
source.AddPreprocessorDefinition("EMISSIVE_SURFACE");
else BUG("Bug on surface type");
if (IsBuiltIn())
{
// fold a set of known uniforms to constants in the shader
// code so that we don't need to set them at runtime.
// the tradeoff is that this creates more shader programs!
source.FoldUniform("kAlphaCutoff", GetAlphaCutoff());
source.FoldUniform("kBaseColor", GetColor(ColorIndex::BaseColor));
source.FoldUniform("kGradientColor0", GetColor(ColorIndex::GradientColor0));
source.FoldUniform("kGradientColor1", GetColor(ColorIndex::GradientColor1));
source.FoldUniform("kGradientColor2", GetColor(ColorIndex::GradientColor2));
source.FoldUniform("kGradientColor3", GetColor(ColorIndex::GradientColor3));
source.FoldUniform("kGradientGamma", GetGradientGamma());
source.FoldUniform("kGradientWeight", GetGradientWeight());
source.FoldUniform("kGradientType", static_cast<unsigned>(GetGradientType()));
source.FoldUniform("kTextureVelocity", GetTextureVelocity());
source.FoldUniform("kTextureVelocityXY", glm::vec2(GetTextureVelocity()));
source.FoldUniform("kTextureVelocityZ", GetTextureVelocity().z);
source.FoldUniform("kTextureRotation", GetTextureRotation());
source.FoldUniform("kTextureScale", GetTextureScale());
source.FoldUniform("kTileSize", GetTileSize());
source.FoldUniform("kTileOffset", GetTileOffset());
source.FoldUniform("kTilePadding", GetTilePadding());
source.FoldUniform("kSurfaceType", static_cast<unsigned>(mSurfaceType));
source.FoldUniform("kParticleStartColor", GetParticleStartColor());
source.FoldUniform("kParticleEndColor", GetParticleEndColor());
source.FoldUniform("kParticleMidColor", GetParticleMidColor());
source.FoldUniform("kParticleBaseRotation", GetParticleBaseRotation());
source.FoldUniform("kAmbientColor", GetAmbientColor());
source.FoldUniform("kDiffuseColor", GetDiffuseColor());
source.FoldUniform("kSpecularColor", GetSpecularColor());
source.FoldUniform("kSpecularExponent", GetSpecularExponent());
}
}
else
{
source.AddPreprocessorDefinition("DYNAMIC_SHADER_SOURCE");
}
return source;
}
bool MaterialClass::ApplyDynamicState(const State& state, Device& device, ProgramState& program) const noexcept
{
program.SetUniform("kTime", (float)state.material_time);
program.SetUniform("kEditingMode", (int)state.editing_mode);
program.SetUniform("kSurfaceType", static_cast<unsigned>(mSurfaceType));
program.SetUniform("kMaterialFlags", static_cast<unsigned>(state.flags));
// for the future... for different render passes we got two options
// either the single shader implements the different render pass
// functionality or then there are different shaders for different passes
// program.SetUniform("kRenderPass", (int)state.renderpass);
if (mType == Type::Color)
{
if (!IsStatic())
{
SetUniform("kBaseColor", state.uniforms, GetBaseColor(), program);
}
}
else if (mType == Type::Gradient)
{
if (!IsStatic())
{
SetUniform("kGradientColor0", state.uniforms, GetColor(ColorIndex::GradientColor0), program);
SetUniform("kGradientColor1", state.uniforms, GetColor(ColorIndex::GradientColor1), program);
SetUniform("kGradientColor2", state.uniforms, GetColor(ColorIndex::GradientColor2), program);
SetUniform("kGradientColor3", state.uniforms, GetColor(ColorIndex::GradientColor3), program);
SetUniform("kGradientWeight", state.uniforms, GetGradientWeight(), program);
SetUniform("kGradientGamma", state.uniforms, GetGradientGamma(), program);
SetUniform("kGradientType", state.uniforms, static_cast<unsigned>(GetGradientType()), program);
}
}
else if (mType == Type::Sprite)
return ApplySpriteDynamicState(state, device, program);
else if (mType == Type::Texture)
return ApplyTextureDynamicState(state, device, program);
else if (mType == Type::Tilemap)
return ApplyTilemapDynamicState(state, device, program);
else if (mType == Type::Particle2D)
return ApplyParticleDynamicState(state, device, program);
else if (mType == Type::BasicLight)
return ApplyBasicLightDynamicState(state, device, program);
else if (mType == Type::Custom)
return ApplyCustomDynamicState(state, device, program);
else BUG("Unknown material type.");
return true;
}
void MaterialClass::ApplyStaticState(const State& state, Device& device, ProgramState& program) const noexcept
{
if (mType == Type::Color)
{
program.SetUniform("kBaseColor", GetBaseColor());
}
else if (mType == Type::Gradient)
{
program.SetUniform("kGradientColor0", GetColor(ColorIndex::GradientColor0));
program.SetUniform("kGradientColor1", GetColor(ColorIndex::GradientColor1));
program.SetUniform("kGradientColor2", GetColor(ColorIndex::GradientColor2));
program.SetUniform("kGradientColor3", GetColor(ColorIndex::GradientColor3));
program.SetUniform("kGradientWeight", GetGradientWeight());
program.SetUniform("kGradientGamma", GetGradientGamma());
program.SetUniform("kGradientType", static_cast<unsigned>(GetGradientType()));
}
else if (mType == Type::Sprite)
{
program.SetUniform("kBaseColor", GetBaseColor());
program.SetUniform("kTextureScale", GetTextureScale());
program.SetUniform("kTextureVelocity", GetTextureVelocity());
program.SetUniform("kTextureRotation", GetTextureRotation());
program.SetUniform("kAlphaCutoff", GetAlphaCutoff());
}
else if (mType == Type::Texture)
{
program.SetUniform("kBaseColor", GetBaseColor());
program.SetUniform("kTextureScale", GetTextureScale());
program.SetUniform("kTextureVelocity", GetTextureVelocity());
program.SetUniform("kTextureRotation", GetTextureRotation());
program.SetUniform("kAlphaCutoff", GetAlphaCutoff());
}
else if (mType == Type::Tilemap)
{
program.SetUniform("kBaseColor", GetBaseColor());
program.SetUniform("kAlphaCutoff", GetAlphaCutoff());
// I'm not sure if there's a use case for setting the texture
// scale or texture velocity. so we're not applying these now.
}
else if (mType ==Type::Particle2D)
{
program.SetUniform("kParticleStartColor", GetParticleStartColor());
program.SetUniform("kParticleEndColor", GetParticleEndColor());
program.SetUniform("kParticleMidColor", GetParticleMidColor());
program.SetUniform("kParticleBaseRotation", GetParticleBaseRotation());
}
else if (mType == Type::BasicLight)
{
program.SetUniform("kAmbientColor", GetAmbientColor());
program.SetUniform("kDiffuseColor", GetDiffuseColor());
program.SetUniform("kSpecularColor", GetSpecularColor());
program.SetUniform("kSpecularExponent", GetSpecularExponent());
}
else if (mType == Type::Custom)
{
// nothing to do here, static state should be in the shader
// already, either by the shader programmer or by the shader
// source generator.
} else BUG("Unknown material type.");
}
void MaterialClass::IntoJson(data::Writer& data) const
{
data.Write("type", mType);
data.Write("id", mClassId);
data.Write("name", mName);
data.Write("shader_uri", mShaderUri);
data.Write("shader_src", mShaderSrc);
data.Write("active_texture_map", mActiveTextureMap);
data.Write("surface", mSurfaceType);
data.Write("texture_min_filter", mTextureMinFilter);
data.Write("texture_mag_filter", mTextureMagFilter);
data.Write("texture_wrap_x", mTextureWrapX);
data.Write("texture_wrap_y", mTextureWrapY);
data.Write("flags", mFlags);
// use an ordered set for persisting the data to make sure
// that the order in which the uniforms are written out is
// defined in order to avoid unnecessary changes (as perceived
// by a version control such as Git) when there's no actual
// change in the data.
std::set<std::string> uniform_keys;
for (const auto& uniform : mUniforms)
uniform_keys.insert(uniform.first);
for (const auto& key : uniform_keys)
{
const auto& uniform = *base::SafeFind(mUniforms, key);
auto chunk = data.NewWriteChunk();
chunk->Write("name", key);
std::visit([&chunk](const auto& variant_value) {
chunk->Write("value", variant_value);
}, uniform);
data.AppendChunk("uniforms", std::move(chunk));
}
for (const auto& map : mTextureMaps)
{
auto chunk = data.NewWriteChunk();
map->IntoJson(*chunk);
ASSERT(chunk->HasValue("name")); // moved into TextureMap::IntoJson
ASSERT(chunk->HasValue("type")); // moved into TextureMap::IntoJson
//chunk->Write("name", key);
//chunk->Write("type", map->GetType());
data.AppendChunk("texture_maps", std::move(chunk));
}
}
template<typename T> // static
bool MaterialClass::SetUniform(const char* name, const UniformMap* uniforms, const T& backup, ProgramState& program)
{
if (uniforms)
{
auto it = uniforms->find(name);
if (it == uniforms->end())
{
program.SetUniform(name, backup);
return true;
}
const auto& value = it->second;
if (const auto* ptr = std::get_if<T>(&value))
{
program.SetUniform(name, *ptr);
return true;
}
}
program.SetUniform(name, backup);
return false;
}
// static
bool MaterialClass::SetUniform(const char* name, const UniformMap* uniforms, unsigned backup, ProgramState& program)
{
if (uniforms)
{
auto it = uniforms->find(name);
if (it == uniforms->end())
{
program.SetUniform(name, backup);
return true;
}
const auto& value = it->second;
// right now we're only exposing int type in the supported uniforms.
// adding unsigned requires all the layers above to change too and
// make sure they deal with int vs unsigned int properly. Including
// Lua scripting and UI layers...
// But since we're only using this as a flag type it should be fine
// for now.
if (const auto* ptr = std::get_if<int>(&value))
{
if (*ptr > 0)
{
program.SetUniform(name, *ptr);
return true;
}
}
}
program.SetUniform(name, backup);
return false;
}
template<typename T>
bool MaterialClass::ReadLegacyValue(const char* name, const char* uniform, const data::Reader& data)
{
if (!data.HasValue(name))
return true;
T the_old_value;
if (!data.Read(name, &the_old_value))
return false;
SetUniform(uniform, the_old_value);
return true;
}
bool MaterialClass::FromJson(const data::Reader& data)
{
bool ok = true;
ok &= data.Read("type", &mType);
ok &= data.Read("id", &mClassId);
ok &= data.Read("name", &mName);
ok &= data.Read("shader_uri", &mShaderUri);
ok &= data.Read("shader_src", &mShaderSrc);
ok &= data.Read("active_texture_map", &mActiveTextureMap);
ok &= data.Read("surface", &mSurfaceType);
ok &= data.Read("texture_min_filter", &mTextureMinFilter);
ok &= data.Read("texture_mag_filter", &mTextureMagFilter);
ok &= data.Read("texture_wrap_x", &mTextureWrapX);
ok &= data.Read("texture_wrap_y", &mTextureWrapY);
ok &= data.Read("flags", &mFlags);
// these member variables have been folded into the generic uniform map.
// this is the old way they were written out and this code migrates the
// old materials from member variables -> uniform map.
ok &= ReadLegacyValue<Color4f>("color_map0", "kColor0", data);
ok &= ReadLegacyValue<Color4f>("color_map1", "kColor1", data);
ok &= ReadLegacyValue<Color4f>("color_map2", "kColor2", data);
ok &= ReadLegacyValue<Color4f>("color_map3", "kColor3", data);
ok &= ReadLegacyValue<glm::vec2>("color_weight", "kGradientWeight", data);
ok &= ReadLegacyValue<glm::vec2>("texture_scale", "kTextureScale", data);
ok &= ReadLegacyValue<glm::vec3>("texture_velocity", "kTextureVelocity", data);
ok &= ReadLegacyValue<float>("texture_rotation", "kTextureRotation", data);
if (data.HasValue("particle_action"))
{
// migrated to use a uniform
ParticleEffect effect;
ok &= data.Read("particle_action", &effect);
if (effect != ParticleEffect::None)
SetParticleEffect(effect);
}
if (data.HasValue("static"))
{
bool static_content = false;
ok &= data.Read("static", &static_content);
mFlags.set(Flags::Static, static_content);
}
if (mType == Type::Color)
{
if (data.HasValue("color"))
ok &= ReadLegacyValue<Color4f>("color", "kBaseColor", data);
}
else if (mType == Type::Gradient)
{
if (data.HasValue("offset"))
ok &= ReadLegacyValue<glm::vec2>("offset", "kWeight", data);
if (data.HasValue("kWeight"))
ok &= ReadLegacyValue<glm::vec2>("kWeight", "kGradientWeight", data);
}
else if (mType == Type::Texture)
{
if (data.HasValue("color"))
ok &= ReadLegacyValue<Color4f>("color", "kBaseColor", data);
if (!data.HasArray("texture_maps"))
{
if (data.HasChunk("texture_map"))
{
const auto& chunk = data.GetReadChunk("texture_map");
mTextureMaps.emplace_back(new TextureMap);
ok &= mTextureMaps[0]->FromJson(*chunk);
}
else
{
mTextureMaps.emplace_back(new TextureMap);
ok &= mTextureMaps[0]->FromLegacyJsonTexture2D(data);
}
if (mTextureMaps.size() > 1)
mTextureMaps.resize(1);
}
}
else if (mType == Type::Sprite)
{
if (data.HasValue("color"))
ok &= ReadLegacyValue<Color4f>("color", "kBaseColor", data);
if (data.HasValue("blending"))
{
bool blend_frames = false;
ok &= data.Read("blending", &blend_frames);
mFlags.set(Flags::BlendFrames, blend_frames);
}
else if (data.HasValue("blend_frames"))
{
bool blend_frames = false;
ok &= data.Read("blend_frames", &blend_frames);
mFlags.set(Flags::BlendFrames, blend_frames);
}
if (!data.HasArray("texture_maps"))
{
if (data.GetNumChunks("sprites"))
{
const auto& chunk = data.GetReadChunk("sprites", 0);
mTextureMaps.emplace_back(new TextureMap);
ok &= mTextureMaps[0]->FromJson(*chunk);
}
else
{
mTextureMaps.emplace_back(new TextureMap);
ok &= mTextureMaps[0]->FromJson(data);
}
}
}
for (unsigned i=0; i<data.GetNumChunks("uniforms"); ++i)
{
Uniform uniform;
const auto& chunk = data.GetReadChunk("uniforms", i);
std::string name;
ok &= chunk->Read("name", &name);
ok &= chunk->Read("value", &uniform);
mUniforms[std::move(name)] = std::move(uniform);
}
// this migration here is duplicate (there's also a migration in the
// editor resource system) exists to simplify the preset particle
// migration since those don't use the editor's resource system.
if (base::Contains(mUniforms, "kParticleStartColor") &&
base::Contains(mUniforms, "kParticleEndColor") &&
!base::Contains(mUniforms, "kParticleMidColor"))
{
const auto& start_color = GetParticleStartColor();
const auto& end_color = GetParticleEndColor();
const auto& mid_color = start_color * 0.5f + end_color * 0.5f;
SetParticleMidColor(mid_color);
DEBUG("Fabricated particle material mid-way color value. [name='%1']", mName);
}
for (unsigned i=0; i<data.GetNumChunks("texture_maps"); ++i)
{
const auto& chunk = data.GetReadChunk("texture_maps", i);
std::string name;
TextureMap::Type type;
if (chunk->Read("type", &type) && chunk->Read("name", &name))
{
auto map = std::make_unique<TextureMap>();
if (type == TextureMap::Type::Texture2D)
{
if (!chunk->HasValue("sampler_name0"))
ok &= map->FromLegacyJsonTexture2D(*chunk);
else ok &= map->FromJson(*chunk);
}
else
{
ok &= map->FromJson(*chunk);
}
mTextureMaps.push_back(std::move(map));
} else ok = false;
}
return ok;
}
std::unique_ptr<MaterialClass> MaterialClass::Copy() const
{
return std::make_unique<MaterialClass>(*this, true);
}
std::unique_ptr<MaterialClass> MaterialClass::Clone() const
{
return std::make_unique<MaterialClass>(*this, false);
}
void MaterialClass::BeginPacking(TexturePacker* packer) const
{
for (const auto& map : mTextureMaps)
{
for (size_t i=0; i<map->GetNumTextures(); ++i)
{
const auto& rect = map->GetTextureRect(i);
const auto* source = map->GetTextureSource(i);
const TexturePacker::ObjectHandle handle = source;
source->BeginPacking(packer);
packer->SetTextureBox(handle, rect);
// when texture rects are used to address a sub rect within the
// texture wrapping on texture coordinates must be done "manually"
// since the HW sampler coords are outside the sub rectangle coords.
// for example if the wrapping is set to wrap on x and our box is
// 0.25 units the HW sampler would not help us here to wrap when the
// X coordinate is 0.26. Instead, we need to do the wrap manually.
// However, this can cause rendering artifacts when texture sampling
// is done depending on the current filter being used.
bool can_combine = true;
const auto& box = rect;
const auto x = box.GetX();
const auto y = box.GetY();
const auto w = box.GetWidth();
const auto h = box.GetHeight();
const float eps = 0.001;
// if the texture uses sub rect then we still have this problem and packing
// won't make it any worse. in other words if the box is the normal 0.f - 1.0f
// (meaning whole texture, not some part of it) then combining and using a
// sub-rect can make the result worse if coordinate wrapping is in fact needed.
if (math::equals(0.0f, x, eps) &&
math::equals(0.0f, y, eps) &&
math::equals(1.0f, w, eps) &&
math::equals(1.0f, h, eps))
{
// is it possible for a texture to go beyond its range and require wrapping?
// the only case we know here is when texture velocity is non-zero
// or when texture scaling is used. we consider these properties to be
// static and not be changed by the game by default at runtime.
// velocity check
const auto& velocity = GetTextureVelocity();
const bool has_x_velocity = !math::equals(0.0f, velocity.x, eps);
const bool has_y_velocity = !math::equals(0.0f, velocity.y, eps);
if (has_x_velocity && (mTextureWrapX == TextureWrapping::Repeat ||
mTextureWrapX == TextureWrapping::Mirror))
can_combine = false;
else if (has_y_velocity && (mTextureWrapY == TextureWrapping::Repeat ||
mTextureWrapY == TextureWrapping::Mirror))
can_combine = false;
// scale check
const auto& scale = GetTextureScale();
if (scale.x > 1.0f && (mTextureWrapX == TextureWrapping::Repeat ||
mTextureWrapX == TextureWrapping::Mirror))
can_combine = false;
else if (scale.y > 1.0f && (mTextureWrapY == TextureWrapping::Repeat ||
mTextureWrapY == TextureWrapping::Mirror))
can_combine = false;
}
packer->SetTextureFlag(handle, TexturePacker::TextureFlags::CanCombine, can_combine);
if (mType == Type::Tilemap)
{
// since we're using absolute sizes for the tile specification the
// texture cannot change or then the absolute dimensions must also change
// (kTileOffset, kTileSize, kTilePadding).
// Or then we disable the texture resizing for now.
packer->SetTextureFlag(handle, TexturePacker::TextureFlags::AllowedToResize, false);
}
}
}
}
void MaterialClass::FinishPacking(const TexturePacker* packer)
{
for (auto& map : mTextureMaps)
{
for (size_t i=0; i<map->GetNumTextures(); ++i)
{
auto* source = map->GetTextureSource(i);
const TexturePacker::ObjectHandle handle = source;
source->FinishPacking(packer);
map->SetTextureRect(i, packer->GetPackedTextureBox(handle));
}
}
}
unsigned MaterialClass::FindTextureMapIndexById(const std::string& id) const
{
unsigned i=0;
for (i=0; i<GetNumTextureMaps(); ++i)
{
const auto* map = GetTextureMap(i);
if (map->GetId() == id)
break;
}
return i;
}
unsigned MaterialClass::FindTextureMapIndexBySampler(const std::string& name, unsigned sampler_index) const
{
unsigned i=0;
for (i=0; i<GetNumTextureMaps(); ++i)
{
const auto* map = GetTextureMap(i);
if (map->GetSamplerName(sampler_index) == name)
break;
}
return i;
}
unsigned MaterialClass::FindTextureMapIndexByName(const std::string& name) const
{
unsigned i=0;
for (i=0; i<GetNumTextureMaps(); ++i)
{
const auto* map = GetTextureMap(i);
if (map->GetName() == name)
break;
}
return i;
}
TextureMap* MaterialClass::FindTextureMapBySampler(const std::string& name, unsigned sampler_index)
{
const auto index = FindTextureMapIndexBySampler(name, sampler_index);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
TextureMap* MaterialClass::FindTextureMapByName(const std::string& name)
{
const auto index = FindTextureMapIndexByName(name);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
TextureMap* MaterialClass::FindTextureMapById(const std::string& id)
{
const auto index = FindTextureMapIndexById(id);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
const TextureMap* MaterialClass::FindTextureMapBySampler(const std::string& name, unsigned sampler_index) const
{
const auto index = FindTextureMapIndexBySampler(name, sampler_index);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
const TextureMap* MaterialClass::FindTextureMapByName(const std::string& name) const
{
const auto index = FindTextureMapIndexByName(name);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
const TextureMap* MaterialClass::FindTextureMapById(const std::string& id) const
{
const auto index = FindTextureMapIndexById(id);
if (index == GetNumTextureMaps())
return nullptr;
return GetTextureMap(index);
}
void MaterialClass::SetTexture(std::unique_ptr<TextureSource> source)
{
if (mTextureMaps.size() != 1)
mTextureMaps.resize(1);
if (mTextureMaps[0] == nullptr)
{
mTextureMaps[0] = std::make_unique<TextureMap>();
if (mType == Type::Sprite)
{
mTextureMaps[0]->SetType(TextureMap::Type::Sprite);
mTextureMaps[0]->SetName("Sprite");
}
else if (mType == Type::Texture)
{
mTextureMaps[0]->SetType(TextureMap::Type::Texture2D);
mTextureMaps[0]->SetName("Texture");
}
}
mTextureMaps[0]->SetNumTextures(1);
mTextureMaps[0]->SetTextureSource(0, std::move(source));
}
void MaterialClass::AddTexture(std::unique_ptr<TextureSource> source)
{
if (mTextureMaps.size() != 1)
mTextureMaps.resize(1);
if (mTextureMaps[0] == nullptr)
{
mTextureMaps[0] = std::make_unique<TextureMap>();
if (mType == Type::Sprite)
{
mTextureMaps[0]->SetType(TextureMap::Type::Sprite);
mTextureMaps[0]->SetName("Sprite");
}
else if (mType == Type::Texture)
{
mTextureMaps[0]->SetType(TextureMap::Type::Texture2D);
mTextureMaps[0]->SetName("Texture");
}
}
const auto count = mTextureMaps[0]->GetNumTextures();
mTextureMaps[0]->SetNumTextures(count+1);
mTextureMaps[0]->SetTextureSource(count, std::move(source));
}
void MaterialClass::DeleteTextureMap(const std::string& id) noexcept
{
base::EraseRemove(mTextureMaps, [&id](const auto& map) {
return map->GetId() == id;