-
Notifications
You must be signed in to change notification settings - Fork 940
/
GlslProg.cpp
executable file
·2054 lines (1777 loc) · 63.3 KB
/
GlslProg.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) 2010, The Cinder Project
All rights reserved.
This code is designed for use with the Cinder C++ library, http://libcinder.org
Redistribution and use in source and binary forms, with or without modification, are permitted provided that
the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and
the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#include "cinder/gl/GlslProg.h"
#include "cinder/gl/Context.h"
#include "cinder/gl/ConstantConversions.h"
#include "cinder/gl/Environment.h"
#include "cinder/gl/scoped.h"
#include "cinder/Log.h"
#include "cinder/Noncopyable.h"
#include "cinder/Utilities.h"
#include "glm/gtc/type_ptr.hpp"
#include <type_traits>
// For stoi and std:;to_string
#if defined( CINDER_ANDROID )
#include "cinder/android/CinderAndroid.h"
#endif
// uncomment this in order to prevent uniform value caching
//#define DISABLE_UNIFORM_CACHING
using namespace std;
namespace cinder { namespace gl {
static GlslProg::UniformSemanticMap sDefaultUniformNameToSemanticMap;
static GlslProg::AttribSemanticMap sDefaultAttribNameToSemanticMap;
class UniformValueCache : cinder::Noncopyable {
public:
UniformValueCache( uint32_t bufferSize )
: mBuffer( new uint8_t[bufferSize] ), mValidBytes( new bool[bufferSize] ), mBufferSize( bufferSize )
{
for( uint32_t b = 0; b < bufferSize; ++b )
mValidBytes[b] = false;
}
// 'uniformByteOffset' expresses where the first element of an array is: example[0], although 'arrayIndex' may be >0
bool shouldBuffer( uint32_t uniformByteOffset, uint32_t typeSize, int arrayIndex, int indexCount, const void* valuePointer )
{
// are all the bytes in this range valid?
bool cacheValid = true;
for( uint32_t b = uniformByteOffset + arrayIndex * typeSize; b < uniformByteOffset + ( arrayIndex + indexCount ) * typeSize; ++b ) {
if( mValidBytes[b] == false ) {
cacheValid = false;
break;
}
}
uint8_t* cachePtr = mBuffer.get() + uniformByteOffset + arrayIndex * typeSize;
if( ! cacheValid ) { // if not, record it and cache it
for( uint32_t b = uniformByteOffset + arrayIndex * typeSize; b < uniformByteOffset + ( arrayIndex + indexCount ) * typeSize; ++b )
mValidBytes[b] = true;
memcpy( cachePtr, valuePointer, typeSize * indexCount );
return true;
}
else {
// we've seen this byteOffset before; did its value change?
if( memcmp( cachePtr, valuePointer, typeSize * indexCount ) == 0 ) {
return false;
}
else { // yes? then cache the latest
memcpy( cachePtr, valuePointer, typeSize * indexCount );
return true;
}
}
}
private:
std::vector<uint32_t> mCachedByteOffsets;
std::unique_ptr<uint8_t[]> mBuffer;
std::unique_ptr<bool[]> mValidBytes;
uint32_t mBufferSize;
};
//////////////////////////////////////////////////////////////////////////
// GlslProg::Attribute
// This function and variable layout is based on the specification from
// https://www.opengl.org/registry/specs/ARB/vertex_attrib_64bit.txt
void GlslProg::Attribute::getShaderAttribLayout( GLenum type, uint32_t *numDimsPerVertexPointer, uint32_t *numLocationsExpected )
{
switch ( type ) {
case GL_UNSIGNED_INT:
case GL_INT:
case GL_FLOAT:
*numDimsPerVertexPointer = 1; *numLocationsExpected = 1;
break;
#if ! defined( CINDER_GL_ES_2 )
case GL_UNSIGNED_INT_VEC2:
#endif
case GL_INT_VEC2:
case GL_FLOAT_VEC2:
*numDimsPerVertexPointer = 2; *numLocationsExpected = 1;
break;
#if ! defined( CINDER_GL_ES_2 )
case GL_UNSIGNED_INT_VEC3:
#endif
case GL_INT_VEC3:
case GL_FLOAT_VEC3:
*numDimsPerVertexPointer = 3; *numLocationsExpected = 1;
break;
#if ! defined( CINDER_GL_ES_2 )
case GL_UNSIGNED_INT_VEC4:
#endif
case GL_INT_VEC4:
case GL_FLOAT_VEC4:
*numDimsPerVertexPointer = 4; *numLocationsExpected = 1;
break;
case GL_FLOAT_MAT2:
*numDimsPerVertexPointer = 2; *numLocationsExpected = 2;
break;
#if ! defined( CINDER_GL_ES_2 )
case GL_FLOAT_MAT2x3:
*numDimsPerVertexPointer = 3; *numLocationsExpected = 2;
break;
case GL_FLOAT_MAT3x2:
*numDimsPerVertexPointer = 2; *numLocationsExpected = 3;
break;
case GL_FLOAT_MAT4x2:
*numDimsPerVertexPointer = 2; *numLocationsExpected = 4;
break;
case GL_FLOAT_MAT2x4:
*numDimsPerVertexPointer = 4; *numLocationsExpected = 2;
break;
#endif
case GL_FLOAT_MAT3:
*numDimsPerVertexPointer = 3; *numLocationsExpected = 3;
break;
#if ! defined( CINDER_GL_ES_2 )
case GL_FLOAT_MAT3x4:
*numDimsPerVertexPointer = 4; *numLocationsExpected = 3;
break;
case GL_FLOAT_MAT4x3:
*numDimsPerVertexPointer = 3; *numLocationsExpected = 4;
break;
#endif
case GL_FLOAT_MAT4:
*numDimsPerVertexPointer = 4; *numLocationsExpected = 4;
break;
default:
CI_LOG_E( "Unknown type for attrib: " << constantToString( type ) );
*numDimsPerVertexPointer = 0; *numLocationsExpected = 0;
break;
}
}
//////////////////////////////////////////////////////////////////////////
// GlslProg::Format
GlslProg::Format::Format()
#if defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
: mTransformFormat( -1 )
#endif
{
mPreprocessor = make_shared<ShaderPreprocessor>();
}
GlslProg::Format& GlslProg::Format::vertex( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mVertexShader, &mVertexShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::vertex( const string &vertexShader )
{
setShaderSource( vertexShader, &mVertexShader, &mVertexShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::fragment( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mFragmentShader, &mFragmentShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::fragment( const string &fragmentShader )
{
setShaderSource( fragmentShader, &mFragmentShader, &mFragmentShaderPath );
return *this;
}
#if defined( CINDER_GL_HAS_GEOM_SHADER )
GlslProg::Format& GlslProg::Format::geometry( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mGeometryShader, &mGeometryShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::geometry( const string &geometryShader )
{
setShaderSource( geometryShader, &mGeometryShader, &mGeometryShaderPath );
return *this;
}
#endif // defined( CINDER_GL_HAS_GEOM_SHADER )
#if defined( CINDER_GL_HAS_TESS_SHADER )
GlslProg::Format& GlslProg::Format::tessellationCtrl( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mTessellationCtrlShader, &mTessellationCtrlShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::tessellationCtrl( const string &tessellationCtrlShader )
{
setShaderSource( tessellationCtrlShader, &mTessellationCtrlShader, &mTessellationCtrlShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::tessellationEval( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mTessellationEvalShader, &mTessellationEvalShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::tessellationEval( const string &tessellationEvalShader )
{
setShaderSource( tessellationEvalShader, &mTessellationEvalShader, &mTessellationEvalShaderPath );
return *this;
}
#endif // defined( CINDER_GL_HAS_TESS_SHADER )
#if defined( CINDER_GL_HAS_COMPUTE_SHADER )
GlslProg::Format& GlslProg::Format::compute( const DataSourceRef &dataSource )
{
setShaderSource( dataSource, &mComputeShader, &mComputeShaderPath );
return *this;
}
GlslProg::Format& GlslProg::Format::compute( const string &computeShader )
{
setShaderSource( computeShader, &mComputeShader, &mComputeShaderPath );
return *this;
}
#endif // defined( CINDER_GL_HAS_COMPUTE_SHADER )
void GlslProg::Format::setShaderSource( const DataSourceRef &dataSource, string *shaderSourceDest, fs::path *shaderPathDest )
{
if( dataSource ) {
auto buffer = dataSource->getBuffer();
const char *data = static_cast<const char *>( buffer->getData() );
*shaderSourceDest = string( data, data + buffer->getSize() );
if( dataSource->isFilePath() )
*shaderPathDest = dataSource->getFilePath();
else
shaderPathDest->clear();
}
else {
shaderSourceDest->clear();
shaderPathDest->clear();
}
}
void GlslProg::Format::setShaderSource( const std::string &source, std::string *shaderSourceDest, fs::path *shaderPathDest )
{
*shaderSourceDest = source;
shaderPathDest->clear();
}
GlslProg::Format& GlslProg::Format::attrib( geom::Attrib semantic, const std::string &attribName )
{
for( auto& attrib : mAttributes ) {
if( attrib.mName == attribName ) {
attrib.mSemantic = semantic;
return *this;
}
else if( attrib.mSemantic == semantic ) {
attrib.mName = attribName;
return *this;
}
}
// no existing definition; add it
Attribute attrib;
attrib.mName = attribName;
attrib.mSemantic = semantic;
mAttributes.push_back( attrib );
return *this;
}
GlslProg::Format& GlslProg::Format::uniform( UniformSemantic semantic, const std::string &uniformName )
{
for( auto& uniform : mUniforms ) {
if( uniform.mName == uniformName ) {
uniform.mSemantic = semantic;
return *this;
}
else if( uniform.mSemantic == semantic ) {
uniform.mName = uniformName;
return *this;
}
}
// no existing definition; add it
Uniform uniform;
uniform.mName = uniformName;
uniform.mSemantic = semantic;
mUniforms.push_back( uniform );
return *this;
}
bool GlslProg::Format::isPreprocessingEnabled() const
{
return (bool)mPreprocessor;
}
void GlslProg::Format::setPreprocessingEnabled( bool enable )
{
if( enable ) {
if( ! mPreprocessor )
mPreprocessor = make_shared<ShaderPreprocessor>();
}
else {
mPreprocessor = nullptr;
}
}
GlslProg::Format& GlslProg::Format::version( int version )
{
if( mPreprocessor )
mPreprocessor->setVersion( version );
return *this;
}
int GlslProg::Format::getVersion() const
{
return mPreprocessor ? mPreprocessor->getVersion() : 0;
}
GlslProg::Format& GlslProg::Format::define( const std::string &define )
{
if( mPreprocessor )
mPreprocessor->addDefine( define );
return *this;
}
GlslProg::Format& GlslProg::Format::define( const std::string &define, const std::string &value )
{
if( mPreprocessor )
mPreprocessor->addDefine( define, value );
return *this;
}
const std::vector<std::pair<std::string,std::string>>& GlslProg::Format::getDefines() const
{
if( mPreprocessor ) {
return mPreprocessor->getDefines();
}
static std::vector<std::pair<std::string,std::string>> sEmpty;
return sEmpty;
}
GlslProg::Format& GlslProg::Format::attribLocation( const std::string &attribName, GLint location )
{
for( auto& attrib : mAttributes ) {
if( attrib.mName == attribName ) {
attrib.mLoc = location;
return *this;
}
else if( attrib.mLoc == location ) {
attrib.mName = attribName;
return *this;
}
}
// no existing definition; add it
Attribute attrib;
attrib.mName = attribName;
attrib.mLoc = location;
mAttributes.push_back( attrib );
return *this;
}
GlslProg::Format& GlslProg::Format::attribLocation( geom::Attrib attribSemantic, GLint location )
{
for( auto& attrib : mAttributes ) {
if( attrib.mSemantic == attribSemantic ) {
attrib.mLoc = location;
return *this;
}
else if( attrib.mLoc == location ) {
attrib.mSemantic = attribSemantic;
return *this;
}
}
Attribute attrib;
attrib.mSemantic = attribSemantic;
attrib.mLoc = location;
mAttributes.push_back( attrib );
return *this;
}
#if ! defined( CINDER_GL_ES )
GlslProg::Format& GlslProg::Format::fragDataLocation( GLuint colorNumber, const std::string &name )
{
mFragDataLocations[name] = colorNumber;
return *this;
}
#endif
//////////////////////////////////////////////////////////////////////////
// GlslProg statics
GlslProgRef GlslProg::create( const Format &format )
{
return GlslProgRef( new GlslProg( format ) );
}
#if ! defined( CINDER_GL_ES )
GlslProgRef GlslProg::create( DataSourceRef vertexShader, DataSourceRef fragmentShader, DataSourceRef geometryShader, DataSourceRef tessEvalShader, DataSourceRef tessCtrlShader )
{
return GlslProgRef( new GlslProg( GlslProg::Format().vertex( vertexShader ).fragment( fragmentShader ).geometry( geometryShader ).tessellationEval( tessEvalShader ).tessellationCtrl( tessCtrlShader ) ) );
}
GlslProgRef GlslProg::create( const string &vertexShader, const string &fragmentShader, const string &geometryShader, const string &tessEvalShader, const string &tessCtrlShader )
{
return GlslProgRef( new GlslProg( GlslProg::Format().vertex( vertexShader ).fragment( fragmentShader ).geometry( geometryShader ).tessellationEval( tessEvalShader ).tessellationCtrl( tessCtrlShader ) ) );
}
#else
GlslProgRef GlslProg::create( DataSourceRef vertexShader, DataSourceRef fragmentShader )
{
return GlslProgRef( new GlslProg( GlslProg::Format().vertex( vertexShader ).fragment( fragmentShader ) ) );
}
GlslProgRef GlslProg::create( const string &vertexShader, const string &fragmentShader )
{
return GlslProgRef( new GlslProg( GlslProg::Format().vertex( vertexShader ).fragment( fragmentShader ) ) );
}
#endif
GlslProg::~GlslProg()
{
auto ctx = gl::context();
if( ctx )
ctx->glslProgDeleted( this );
if( mHandle ) {
glDeleteProgram( (GLuint)mHandle );
}
}
//////////////////////////////////////////////////////////////////////////
// GlslProg
GlslProg::GlslProg( const Format &format )
: mUniformValueCache( nullptr )
#if defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
, mTransformFeedbackFormat( -1 )
#endif
{
mHandle = glCreateProgram();
GLuint vertexHandle = loadShader( format.getVertex(), format.mVertexShaderPath, GL_VERTEX_SHADER, format.getPreprocessor() );
GLuint fragmentHandle = loadShader( format.getFragment(), format.mFragmentShaderPath, GL_FRAGMENT_SHADER, format.getPreprocessor() );
#if defined( CINDER_GL_HAS_GEOM_SHADER )
GLuint geometryHandle = loadShader( format.getGeometry(), format.mGeometryShaderPath, GL_GEOMETRY_SHADER, format.getPreprocessor() );
#endif
#if defined( CINDER_GL_HAS_TESS_SHADER )
GLuint tessellationCtrlHandle = loadShader( format.getTessellationCtrl(), format.mTessellationCtrlShaderPath, GL_TESS_CONTROL_SHADER, format.getPreprocessor() );
GLuint tessellationEvalHandle = loadShader( format.getTessellationEval(), format.mTessellationEvalShaderPath, GL_TESS_EVALUATION_SHADER, format.getPreprocessor() );
#endif
#if defined( CINDER_GL_HAS_COMPUTE_SHADER )
GLuint computeHandle = loadShader( format.getCompute(), format.mComputeShaderPath, GL_COMPUTE_SHADER, format.getPreprocessor() );
#endif
auto &userDefinedAttribs = format.getAttributes();
bool foundPositionSemantic = false;
// if the user has provided a location make sure to bind that location before we go further
for( auto &attrib : userDefinedAttribs ) {
if( attrib.mLoc > -1 ) {
if( attrib.mName == "ciPosition" || attrib.mSemantic == geom::Attrib::POSITION )
foundPositionSemantic = true;
// The user may have defined a location for an attrib but is relying on the default
// name used by Cinder. Therefore, we need to find the attrib in the map and affix
// the default name.
std::string attribName = attrib.mName;
if( attribName.empty() ) {
const auto &defaultAttribMap = getDefaultAttribNameToSemanticMap();
auto attribSemantic = attrib.mSemantic;
auto foundDefaultAttrib = find_if( defaultAttribMap.begin(), defaultAttribMap.end(),
[attribSemantic]( const std::pair<const std::string, geom::Attrib> &defaultAttrib ){
return defaultAttrib.second == attribSemantic;
});
if( foundDefaultAttrib != defaultAttribMap.end() )
attribName = foundDefaultAttrib->first;
else {
CI_LOG_E( "Defined Location for unknown semantic and unknown name" );
continue;
}
}
glBindAttribLocation( mHandle, attrib.mLoc, attribName.c_str() );
}
}
// we always want to force position to be at vertex attribute 0; an imperfect workaround for
// http://stackoverflow.com/questions/13348885/why-does-opengl-drawing-fail-when-vertex-attrib-array-zero-is-disabled
if( ! foundPositionSemantic )
glBindAttribLocation( mHandle, 0, "ciPosition" );
#if defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
if( ! format.getVaryings().empty() && format.getTransformFormat() > 0 ) {
auto & userVaryings = format.getVaryings();
mTransformFeedbackVaryings.resize( format.getVaryings().size() );
std::vector<const GLchar*> transformFeedbackStarts;
int i = 0;
// This is a mess due to an NVidia driver bug on MSW which expects the memory passed to glTransformFeedbackVaryings
// to still be around after the call. We allocate the storage and put it on the GlslProg itself to be freed at destruction
for( auto & transformFeedbackVaryings : mTransformFeedbackVaryings ) {
transformFeedbackVaryings.mName = userVaryings[i++];
transformFeedbackStarts.push_back( transformFeedbackVaryings.mName.c_str() );
}
mTransformFeedbackFormat = format.getTransformFormat();
glTransformFeedbackVaryings( mHandle, (GLsizei)mTransformFeedbackVaryings.size(), transformFeedbackStarts.data(), mTransformFeedbackFormat );
}
#endif
#if ! defined( CINDER_GL_ES )
// setup fragment data locations
for( const auto &fragDataLocation : format.getFragDataLocations() )
glBindFragDataLocation( mHandle, fragDataLocation.second, fragDataLocation.first.c_str() );
#endif
link();
// Detach all shaders, allowing GL to free the associated memory
if( vertexHandle )
glDetachShader( mHandle, vertexHandle );
if( fragmentHandle )
glDetachShader( mHandle, fragmentHandle );
#if defined( CINDER_GL_HAS_GEOM_SHADER )
if( geometryHandle )
glDetachShader( mHandle, geometryHandle );
#endif
#if defined( CINDER_GL_HAS_TESS_SHADER )
if( tessellationCtrlHandle )
glDetachShader( mHandle, tessellationCtrlHandle );
if( tessellationEvalHandle )
glDetachShader( mHandle, tessellationEvalHandle );
#endif
#if defined( CINDER_GL_HAS_COMPUTE_SHADER )
if( computeHandle )
glDetachShader( mHandle, computeHandle );
#endif
cacheActiveAttribs();
cacheActiveUniforms();
#if defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
if( ! format.getVaryings().empty() ) {
cacheActiveTransformFeedbackVaryings();
}
#endif
#if defined( CINDER_GL_HAS_UNIFORM_BLOCKS )
cacheActiveUniformBlocks();
#endif
auto & userDefinedUniforms = format.getUniforms();
// check if the user thinks there's a uniform that isn't active
for( auto &userUniform : userDefinedUniforms ) {
bool foundUserDefined = false;
for( auto & activeUniform : mUniforms ) {
// if the user defined name and the active name are the same
if( userUniform.mName == activeUniform.mName ) {
foundUserDefined = true;
// If we've found the uniform, change the semantic to the
// user defined semantic.
activeUniform.mSemantic = userUniform.mSemantic;
break;
}
}
if( ! foundUserDefined ) {
CI_LOG_W( "Unknown uniform: \"" << userUniform.mName << "\"" );
mLoggedUniformNames.insert( userUniform.mName );
}
}
// make sure we get all of the semantic info correct from the user
for( auto &userAttrib : userDefinedAttribs ) {
bool active = false;
for( auto &activeAttrib : mAttributes ) {
// check if either the user defined name or user defined loc for
// this attrib are the same as the active attribute
if( userAttrib.mName == activeAttrib.mName ||
userAttrib.mLoc == activeAttrib.mLoc ) {
// we've found the user defined attribute
active = true;
// check if the user defined attribute has cached what type
// of semantic this is
if( userAttrib.mSemantic != geom::Attrib::USER_DEFINED ) {
activeAttrib.mSemantic = userAttrib.mSemantic;
}
break;
}
}
if( ! active ) {
CI_LOG_W( "Unknown attribute: \"" << userAttrib.mName << "\"" );
}
}
setLabel( format.getLabel() );
gl::context()->glslProgCreated( this );
}
GlslProg::UniformSemanticMap& GlslProg::getDefaultUniformNameToSemanticMap()
{
static bool initialized = false;
if( ! initialized ) {
sDefaultUniformNameToSemanticMap["ciModelMatrix"] = UNIFORM_MODEL_MATRIX;
sDefaultUniformNameToSemanticMap["ciModelMatrixInverse"] = UNIFORM_MODEL_MATRIX_INVERSE;
sDefaultUniformNameToSemanticMap["ciModelMatrixInverseTranspose"] = UNIFORM_MODEL_MATRIX_INVERSE_TRANSPOSE;
sDefaultUniformNameToSemanticMap["ciViewMatrix"] = UNIFORM_VIEW_MATRIX;
sDefaultUniformNameToSemanticMap["ciViewMatrixInverse"] = UNIFORM_VIEW_MATRIX_INVERSE;
sDefaultUniformNameToSemanticMap["ciModelView"] = UNIFORM_MODEL_VIEW;
sDefaultUniformNameToSemanticMap["ciModelViewInverse"] = UNIFORM_MODEL_VIEW_INVERSE;
sDefaultUniformNameToSemanticMap["ciModelViewInverseTranspose"] = UNIFORM_MODEL_VIEW_INVERSE_TRANSPOSE;
sDefaultUniformNameToSemanticMap["ciModelViewProjection"] = UNIFORM_MODEL_VIEW_PROJECTION;
sDefaultUniformNameToSemanticMap["ciModelViewProjectionInverse"] = UNIFORM_MODEL_VIEW_PROJECTION_INVERSE;
sDefaultUniformNameToSemanticMap["ciProjectionMatrix"] = UNIFORM_PROJECTION_MATRIX;
sDefaultUniformNameToSemanticMap["ciProjectionMatrixInverse"] = UNIFORM_PROJECTION_MATRIX_INVERSE;
sDefaultUniformNameToSemanticMap["ciViewProjection"] = UNIFORM_VIEW_PROJECTION;
sDefaultUniformNameToSemanticMap["ciNormalMatrix"] = UNIFORM_NORMAL_MATRIX;
sDefaultUniformNameToSemanticMap["ciViewportMatrix"] = UNIFORM_VIEWPORT_MATRIX;
sDefaultUniformNameToSemanticMap["ciWindowSize"] = UNIFORM_WINDOW_SIZE;
sDefaultUniformNameToSemanticMap["ciElapsedSeconds"] = UNIFORM_ELAPSED_SECONDS;
initialized = true;
}
return sDefaultUniformNameToSemanticMap;
}
GlslProg::AttribSemanticMap& GlslProg::getDefaultAttribNameToSemanticMap()
{
static bool initialized = false;
if( ! initialized ) {
sDefaultAttribNameToSemanticMap["ciPosition"] = geom::Attrib::POSITION;
sDefaultAttribNameToSemanticMap["ciNormal"] = geom::Attrib::NORMAL;
sDefaultAttribNameToSemanticMap["ciTangent"] = geom::Attrib::TANGENT;
sDefaultAttribNameToSemanticMap["ciBitangent"] = geom::Attrib::BITANGENT;
sDefaultAttribNameToSemanticMap["ciTexCoord0"] = geom::Attrib::TEX_COORD_0;
sDefaultAttribNameToSemanticMap["ciTexCoord1"] = geom::Attrib::TEX_COORD_1;
sDefaultAttribNameToSemanticMap["ciTexCoord2"] = geom::Attrib::TEX_COORD_2;
sDefaultAttribNameToSemanticMap["ciTexCoord3"] = geom::Attrib::TEX_COORD_3;
sDefaultAttribNameToSemanticMap["ciColor"] = geom::Attrib::COLOR;
sDefaultAttribNameToSemanticMap["ciBoneIndex"] = geom::Attrib::BONE_INDEX;
sDefaultAttribNameToSemanticMap["ciBoneWeight"] = geom::Attrib::BONE_WEIGHT;
initialized = true;
}
return sDefaultAttribNameToSemanticMap;
}
GLuint GlslProg::loadShader( const string &shaderSource, const fs::path &shaderPath, GLint shaderType, const ShaderPreprocessorRef &preprocessor )
{
GLuint handle = 0;
if( ! shaderSource.empty() ) {
handle = glCreateShader( shaderType );
if( preprocessor ) {
set<fs::path> includedFiles;
string preprocessedSource = preprocessor->parse( shaderSource, shaderPath, &includedFiles );
mShaderPreprocessorIncludedFiles.insert( mShaderPreprocessorIncludedFiles.end(), includedFiles.begin(), includedFiles.end() );
const char *cStr = preprocessedSource.c_str();
glShaderSource( handle, 1, reinterpret_cast<const GLchar**>( &cStr ), NULL );
}
else {
const char *cStr = shaderSource.c_str();
glShaderSource( handle, 1, reinterpret_cast<const GLchar**>( &cStr ), NULL );
}
glCompileShader( handle );
GLint status;
glGetShaderiv( (GLuint) handle, GL_COMPILE_STATUS, &status );
if( status != GL_TRUE ) {
std::string log = getShaderLog( (GLuint)handle );
#if defined( CINDER_ANDROID ) | defined( CINDER_LINUX )
std::vector<std::string> lines = ci::split( shaderSource, "\r\n" );
if( ! lines.empty() ) {
std::stringstream ss;
for( size_t i = 0; i < lines.size(); ++i ) {
ss << std::setw( (int)std::log( lines.size() ) ) << (i + 1) << ": " << lines[i] << "\n";
}
log += "\n" + ss.str();
}
#endif
// Since the GlslProg destructor will not be called after we throw, we must delete all
// owned GL objects here to avoid leaking. Any other attached shaders will be cleaned up
// when the program is deleted
glDeleteShader( handle );
glDeleteProgram( mHandle );
throw GlslProgCompileExc( log, shaderType );
}
glAttachShader( mHandle, handle );
// Scope the shader's lifetime to the program's. It will be cleaned up when later detached.
glDeleteShader( handle );
}
return handle;
}
void GlslProg::link()
{
glLinkProgram( mHandle );
// test for a GLSL link error and throw it if we have one
GLint status;
glGetProgramiv( mHandle, GL_LINK_STATUS, &status );
if( status != GL_TRUE ) {
string log;
GLint logLength = 0;
GLint charsWritten = 0;
glGetProgramiv( mHandle, GL_INFO_LOG_LENGTH, &logLength );
if( logLength > 0 ) {
unique_ptr<GLchar[]> debugLog( new GLchar[logLength+1] );
glGetProgramInfoLog( mHandle, logLength, &charsWritten, debugLog.get() );
log.append( debugLog.get(), 0, logLength );
}
// Delete owned GL objects before throwing to avoid a leak
glDeleteProgram( mHandle );
throw GlslProgLinkExc( log );
}
}
void GlslProg::cacheActiveAttribs()
{
GLint numActiveAttrs = 0;
glGetProgramiv( mHandle, GL_ACTIVE_ATTRIBUTES, &numActiveAttrs );
auto & semanticNameMap = getDefaultAttribNameToSemanticMap();
for( GLint i = 0; i < numActiveAttrs; ++i ) {
char name[512];
GLsizei nameLength;
GLint count;
GLenum type;
glGetActiveAttrib( mHandle, (GLuint)i, 511, &nameLength, &count, &type, name );
auto loc = glGetAttribLocation( mHandle, name );
geom::Attrib attributeSemantic = geom::Attrib::USER_DEFINED;
auto foundSemantic = semanticNameMap.find( name );
if( foundSemantic != semanticNameMap.end() ) {
attributeSemantic = foundSemantic->second;
}
Attribute attrib;
attrib.mName = name;
attrib.mLoc = loc;
attrib.mCount = count;
attrib.mType = type;
attrib.mSemantic = attributeSemantic;
mAttributes.push_back( attrib );
}
}
void GlslProg::cacheActiveUniforms()
{
GLint numActiveUniforms = 0;
glGetProgramiv( mHandle, GL_ACTIVE_UNIFORMS, &numActiveUniforms );
auto & semanticNameMap = getDefaultUniformNameToSemanticMap();
uint32_t uniformValueCacheSize = 0;
for( GLint i = 0; i < numActiveUniforms; ++i ) {
char name[512];
GLsizei nameLength;
GLint count;
GLenum type;
glGetActiveUniform( mHandle, (GLuint)i, 511, &nameLength, &count, &type, name );
auto loc = glGetUniformLocation( mHandle, name );
// This may be a part of a uniform block, in that case it will be counted as
// an active uniform but have a location of -1. Disregard as we'll catch it
// when we cache the uniform block.
if( loc != -1 ) {
UniformSemantic uniformSemantic = UniformSemantic::UNIFORM_USER_DEFINED;
auto foundSemantic = semanticNameMap.find( name );
if( foundSemantic != semanticNameMap.end() ) {
uniformSemantic = foundSemantic->second;
}
Uniform uniform;
uniform.mName = name;
uniform.mLoc = loc;
uniform.mIndex = i;
uniform.mCount = count;
uniform.mType = type;
uniform.mTypeSize = gl::typeToBytes( type );
uniform.mSemantic = uniformSemantic;
uniform.mBytePointer = uniformValueCacheSize;
uniformValueCacheSize += uniform.mTypeSize * count;
mUniforms.push_back( uniform );
}
}
#if ! defined( DISABLE_UNIFORM_CACHING )
if( numActiveUniforms )
mUniformValueCache = unique_ptr<UniformValueCache>( new UniformValueCache( uniformValueCacheSize ) );
#endif
}
#if defined( CINDER_GL_HAS_UNIFORM_BLOCKS )
void GlslProg::cacheActiveUniformBlocks()
{
GLint numActiveUniformBlocks = 0;
glGetProgramiv( mHandle, GL_ACTIVE_UNIFORM_BLOCKS, &numActiveUniformBlocks );
auto & semanticNameMap = getDefaultUniformNameToSemanticMap();
for( GLint i = 0; i < numActiveUniformBlocks; i++ ) {
GLchar name[500];
GLsizei nameLength;
GLint blockBinding;
GLint dataSize;
GLint numActiveUniforms;
glGetActiveUniformBlockName( mHandle, i, 500, &nameLength, name );
name[nameLength] = 0;
glGetActiveUniformBlockiv( mHandle, i, GL_UNIFORM_BLOCK_BINDING, &blockBinding );
glGetActiveUniformBlockiv( mHandle, i, GL_UNIFORM_BLOCK_DATA_SIZE, &dataSize );
glGetActiveUniformBlockiv( mHandle, i, GL_UNIFORM_BLOCK_ACTIVE_UNIFORMS, &numActiveUniforms );
const GLuint loc = glGetUniformBlockIndex( mHandle, name );
UniformBlock uniformBlock;
uniformBlock.mName = name;
uniformBlock.mLoc = loc;
uniformBlock.mDataSize = dataSize;
uniformBlock.mBlockBinding = blockBinding;
std::vector<GLint> uniformIndices( numActiveUniforms );
glGetActiveUniformBlockiv( mHandle, i, GL_UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES, uniformIndices.data() );
std::vector<GLuint> unSignedIndices( numActiveUniforms );
int j = 0;
for( auto & index : uniformIndices ) {
char name[512];
GLsizei nameLength;
GLint count;
GLenum type;
glGetActiveUniform( mHandle, (GLuint)index, 511, &nameLength, &count, &type, name );
UniformSemantic uniformSemantic = UniformSemantic::UNIFORM_USER_DEFINED;
auto foundSemantic = semanticNameMap.find( name );
if( foundSemantic != semanticNameMap.end() ) {
uniformSemantic = foundSemantic->second;
}
Uniform uniform;
uniform.mName = name;
uniform.mLoc = -1;
uniform.mIndex = index;
uniform.mCount = count;
uniform.mType = type;
uniform.mSemantic = uniformSemantic;
unSignedIndices[j++]= index;
uniformBlock.mActiveUniforms.push_back( uniform );
}
std::vector<GLint> uniformOffset( numActiveUniforms );
glGetActiveUniformsiv( mHandle,
numActiveUniforms,
unSignedIndices.data(),
GL_UNIFORM_OFFSET,
uniformOffset.data() );
std::vector<GLint> uniformArrayStride( numActiveUniforms );
glGetActiveUniformsiv( mHandle,
numActiveUniforms,
unSignedIndices.data(),
GL_UNIFORM_ARRAY_STRIDE,
uniformArrayStride.data() );
std::vector<GLint> uniformMatrixStride( numActiveUniforms );
glGetActiveUniformsiv( mHandle,
numActiveUniforms,
unSignedIndices.data(),
GL_UNIFORM_MATRIX_STRIDE,
uniformMatrixStride.data() );
uniformBlock.mActiveUniformInfo.insert( make_pair( GL_UNIFORM_OFFSET, uniformOffset ) );
uniformBlock.mActiveUniformInfo.insert( make_pair( GL_UNIFORM_ARRAY_STRIDE, uniformArrayStride ) );
uniformBlock.mActiveUniformInfo.insert( make_pair( GL_UNIFORM_MATRIX_STRIDE, uniformMatrixStride ) );
mUniformBlocks.push_back( uniformBlock );
}
}
#endif // defined( CINDER_GL_HAS_UNIFORM_BLOCKS )
#if defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
void GlslProg::cacheActiveTransformFeedbackVaryings()
{
GLint numActiveTransformFeedbackVaryings;
glGetProgramiv( mHandle, GL_TRANSFORM_FEEDBACK_VARYINGS, &numActiveTransformFeedbackVaryings );
if( numActiveTransformFeedbackVaryings > 0 ) {
for( int i = 0; i < numActiveTransformFeedbackVaryings; i++ ) {
GLchar name[500];
GLint length;
GLsizei count;
GLenum type;
glGetTransformFeedbackVarying( mHandle, i, 500, &length, &count, &type, name );
name[length] = 0;
// So they've told us at setup what to look for. Find the varying, they told us
// about so that we can finish the setup.
auto varying = findTransformFeedbackVaryings( name );
if( varying ) {
varying->mCount = count;
varying->mType = type;
}
}
}
}
#endif // defined( CINDER_GL_HAS_TRANSFORM_FEEDBACK )
void GlslProg::bind() const
{
// this will in turn call bindImpl; this is so that the context can update its reference to the active shader
gl::context()->bindGlslProg( const_cast<GlslProg*>( this ) );
}
// This is called by the Context whenever a GlslProg is bound. The indirection is so that the Context can update its reference to the active shader
void GlslProg::bindImpl() const
{
glUseProgram( mHandle );
}
std::string GlslProg::getShaderLog( GLuint handle ) const
{
string log;
GLchar* debugLog;
GLint charsWritten = 0;
GLint debugLength = 0;
glGetShaderiv( handle, GL_INFO_LOG_LENGTH, &debugLength );
if( debugLength > 0 ) {
debugLog = new GLchar[debugLength];
glGetShaderInfoLog( handle, debugLength, &charsWritten, debugLog );
log.append( debugLog, 0, debugLength );
delete [] debugLog;
}
return log;
}