blob: e6d22c4369d8b5475e8865bfadcb92e880aeb58b [file] [log] [blame]
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00001//
Geoff Lang1b6edcb2014-02-03 14:27:56 -05002// Copyright (c) 2002-2014 The ANGLE Project Authors. All rights reserved.
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +00003// Use of this source code is governed by a BSD-style license that can be
4// found in the LICENSE file.
5//
6
7// Program.h: Defines the gl::Program class. Implements GL program objects
8// and related functionality. [OpenGL ES 2.0.24] section 2.10.3 page 28.
9
Geoff Lang0a73dd82014-11-19 16:18:08 -050010#ifndef LIBANGLE_PROGRAM_H_
11#define LIBANGLE_PROGRAM_H_
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000012
Geoff Lang0b7eef72014-06-12 14:10:47 -040013#include <GLES2/gl2.h>
Jamie Madill861ebb32016-11-17 16:40:22 -050014#include <GLSLANG/ShaderVars.h>
Geoff Lang0b7eef72014-06-12 14:10:47 -040015
Jamie Madilla7d12dc2016-12-13 15:08:19 -050016#include <array>
Jamie Madill861ebb32016-11-17 16:40:22 -050017#include <map>
Jamie Madill63805b42015-08-25 13:17:39 -040018#include <set>
Jamie Madill71c3b2c2015-05-07 11:49:20 -040019#include <sstream>
Geoff Lang0b7eef72014-06-12 14:10:47 -040020#include <string>
Jamie Madill63805b42015-08-25 13:17:39 -040021#include <vector>
Geoff Lang0b7eef72014-06-12 14:10:47 -040022
Jamie Madill3d3d2f22015-09-23 16:47:51 -040023#include "common/angleutils.h"
24#include "common/mathutil.h"
25#include "common/Optional.h"
26
Jamie Madill3d3d2f22015-09-23 16:47:51 -040027#include "libANGLE/Constants.h"
Geoff Lang70d0f492015-12-10 17:45:46 -050028#include "libANGLE/Debug.h"
Jamie Madill3d3d2f22015-09-23 16:47:51 -040029#include "libANGLE/Error.h"
30#include "libANGLE/RefCountObject.h"
jchen107a20b972017-06-13 14:25:26 +080031#include "libANGLE/Uniform.h"
32#include "libANGLE/angletypes.h"
Jamie Madill3d3d2f22015-09-23 16:47:51 -040033
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000034namespace rx
35{
Jamie Madill7aea7e02016-05-10 10:39:45 -040036class GLImplFactory;
Geoff Lang7dd2e102014-11-10 15:19:26 -050037class ProgramImpl;
Jamie Madill5c6b7bf2015-08-17 12:53:35 -040038struct TranslatedAttribute;
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000039}
daniel@transgaming.come6842292010-04-20 18:52:50 +000040
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000041namespace gl
42{
Brandon Jones43a53e22014-08-28 16:23:22 -070043struct Caps;
Jamie Madilla2c74982016-12-12 11:20:42 -050044class Context;
Jamie Madilldfde6ab2016-06-09 07:07:18 -070045class ContextState;
shannon.woods@transgaming.com486d9e92013-02-28 23:15:41 +000046class Shader;
Geoff Lang4ddf5af2016-12-01 14:30:44 -050047class ShaderProgramManager;
Jamie Madillf4f8db82017-02-15 09:31:39 -050048class State;
Geoff Lang7dd2e102014-11-10 15:19:26 -050049class InfoLog;
Geoff Lang7dd2e102014-11-10 15:19:26 -050050class Buffer;
51class Framebuffer;
Jamie Madill192745a2016-12-22 15:58:21 -050052struct PackedVarying;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +000053
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000054extern const char * const g_fakepath;
55
Jamie Madillf0d10f82015-03-31 12:56:52 -040056class InfoLog : angle::NonCopyable
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000057{
58 public:
59 InfoLog();
60 ~InfoLog();
61
Jamie Madill71c3b2c2015-05-07 11:49:20 -040062 size_t getLength() const;
Geoff Lange1a27752015-10-05 13:16:04 -040063 void getLog(GLsizei bufSize, GLsizei *length, char *infoLog) const;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000064
65 void appendSanitized(const char *message);
apatrick@chromium.org253b8d22012-06-22 19:27:21 +000066 void reset();
Jamie Madillf6113162015-05-07 11:49:21 -040067
68 // This helper class ensures we append a newline after writing a line.
69 class StreamHelper : angle::NonCopyable
70 {
71 public:
72 StreamHelper(StreamHelper &&rhs)
73 : mStream(rhs.mStream)
74 {
75 rhs.mStream = nullptr;
76 }
77
78 StreamHelper &operator=(StreamHelper &&rhs)
79 {
80 std::swap(mStream, rhs.mStream);
81 return *this;
82 }
83
84 ~StreamHelper()
85 {
86 // Write newline when destroyed on the stack
87 if (mStream)
88 {
89 (*mStream) << std::endl;
90 }
91 }
92
93 template <typename T>
94 StreamHelper &operator<<(const T &value)
95 {
96 (*mStream) << value;
97 return *this;
98 }
99
100 private:
101 friend class InfoLog;
102
103 StreamHelper(std::stringstream *stream)
104 : mStream(stream)
105 {
106 ASSERT(stream);
107 }
108
109 std::stringstream *mStream;
110 };
111
112 template <typename T>
113 StreamHelper operator<<(const T &value)
114 {
Jamie Madill23176ce2017-07-31 14:14:33 -0400115 ensureInitialized();
116 StreamHelper helper(mLazyStream.get());
Jamie Madillf6113162015-05-07 11:49:21 -0400117 helper << value;
118 return helper;
119 }
120
Jamie Madill23176ce2017-07-31 14:14:33 -0400121 std::string str() const { return mLazyStream ? mLazyStream->str() : ""; }
Jamie Madillf6113162015-05-07 11:49:21 -0400122
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000123 private:
Jamie Madill23176ce2017-07-31 14:14:33 -0400124 void ensureInitialized()
125 {
126 if (!mLazyStream)
127 {
128 mLazyStream.reset(new std::stringstream());
129 }
130 }
131
132 std::unique_ptr<std::stringstream> mLazyStream;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000133};
134
Geoff Lang7dd2e102014-11-10 15:19:26 -0500135// Struct used for correlating uniforms/elements of uniform arrays to handles
136struct VariableLocation
137{
Jamie Madillfb997ec2017-09-20 15:44:27 -0400138 static constexpr unsigned int kUnused = GL_INVALID_INDEX;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500139
Jamie Madillfb997ec2017-09-20 15:44:27 -0400140 VariableLocation();
141 VariableLocation(unsigned int element, unsigned int index);
Geoff Langd8605522016-04-13 10:19:12 -0400142
Jamie Madillfe8b5982017-09-07 17:00:18 -0400143 // If used is false, it means this location is only used to fill an empty space in an array,
144 // and there is no corresponding uniform variable for this location. It can also mean the
145 // uniform was optimized out by the implementation.
Jamie Madillfb997ec2017-09-20 15:44:27 -0400146 bool used() const { return (index != kUnused); }
147 void markUnused() { index = kUnused; }
148 void markIgnored() { ignored = true; }
149
150 unsigned int element;
151 unsigned int index;
Geoff Langd8605522016-04-13 10:19:12 -0400152
153 // If this location was bound to an unreferenced uniform. Setting data on this uniform is a
154 // no-op.
155 bool ignored;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500156};
157
Sami Väisänen46eaa942016-06-29 10:26:37 +0300158// Information about a variable binding.
159// Currently used by CHROMIUM_path_rendering
160struct BindingInfo
161{
162 // The type of binding, for example GL_FLOAT_VEC3.
163 // This can be GL_NONE if the variable is optimized away.
164 GLenum type;
165
166 // This is the name of the variable in
167 // the translated shader program. Note that
168 // this can be empty in the case where the
169 // variable has been optimized away.
170 std::string name;
171
172 // True if the binding is valid, otherwise false.
173 bool valid;
174};
175
Jamie Madille7d84322017-01-10 18:21:59 -0500176// This small structure encapsulates binding sampler uniforms to active GL textures.
177struct SamplerBinding
178{
Jamie Madill54164b02017-08-28 15:17:37 -0400179 SamplerBinding(GLenum textureTypeIn, size_t elementCount, bool unreferenced)
180 : textureType(textureTypeIn), boundTextureUnits(elementCount, 0), unreferenced(unreferenced)
Jamie Madille7d84322017-01-10 18:21:59 -0500181 {
182 }
183
184 // Necessary for retrieving active textures from the GL state.
185 GLenum textureType;
186
187 // List of all textures bound to this sampler, of type textureType.
188 std::vector<GLuint> boundTextureUnits;
Jamie Madill54164b02017-08-28 15:17:37 -0400189
190 // A note if this sampler is an unreferenced uniform.
191 bool unreferenced;
Jamie Madille7d84322017-01-10 18:21:59 -0500192};
193
jchen10a9042d32017-03-17 08:50:45 +0800194// A varying with tranform feedback enabled. If it's an array, either the whole array or one of its
195// elements specified by 'arrayIndex' can set to be enabled.
196struct TransformFeedbackVarying : public sh::Varying
197{
198 TransformFeedbackVarying(const sh::Varying &varyingIn, GLuint index)
199 : sh::Varying(varyingIn), arrayIndex(index)
200 {
201 }
202 std::string nameWithArrayIndex() const
203 {
204 std::stringstream fullNameStr;
205 fullNameStr << name;
206 if (arrayIndex != GL_INVALID_INDEX)
207 {
208 fullNameStr << "[" << arrayIndex << "]";
209 }
210 return fullNameStr.str();
211 }
212 GLsizei size() const { return (arrayIndex == GL_INVALID_INDEX ? elementCount() : 1); }
213
214 GLuint arrayIndex;
215};
216
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800217struct ImageBinding
218{
Xinghua Cao0328b572017-06-26 15:51:36 +0800219 ImageBinding(size_t count) : boundImageUnits(count, 0) {}
220 ImageBinding(GLuint imageUnit, size_t count)
221 {
222 for (size_t index = 0; index < count; ++index)
223 {
224 boundImageUnits.push_back(imageUnit + static_cast<GLuint>(index));
225 }
226 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800227
Xinghua Cao0328b572017-06-26 15:51:36 +0800228 std::vector<GLuint> boundImageUnits;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800229};
230
Jamie Madill48ef11b2016-04-27 15:21:52 -0400231class ProgramState final : angle::NonCopyable
232{
233 public:
234 ProgramState();
235 ~ProgramState();
236
237 const std::string &getLabel();
238
Jamie Madillbd044ed2017-06-05 12:59:21 -0400239 Shader *getAttachedVertexShader() const { return mAttachedVertexShader; }
240 Shader *getAttachedFragmentShader() const { return mAttachedFragmentShader; }
241 Shader *getAttachedComputeShader() const { return mAttachedComputeShader; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400242 const std::vector<std::string> &getTransformFeedbackVaryingNames() const
243 {
244 return mTransformFeedbackVaryingNames;
245 }
246 GLint getTransformFeedbackBufferMode() const { return mTransformFeedbackBufferMode; }
247 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const
248 {
jchen107a20b972017-06-13 14:25:26 +0800249 ASSERT(uniformBlockIndex < mUniformBlocks.size());
250 return mUniformBlocks[uniformBlockIndex].binding;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400251 }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800252 GLuint getShaderStorageBlockBinding(GLuint blockIndex) const
253 {
254 ASSERT(blockIndex < mShaderStorageBlocks.size());
255 return mShaderStorageBlocks[blockIndex].binding;
256 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400257 const UniformBlockBindingMask &getActiveUniformBlockBindingsMask() const
258 {
259 return mActiveUniformBlockBindings;
260 }
261 const std::vector<sh::Attribute> &getAttributes() const { return mAttributes; }
262 const AttributesMask &getActiveAttribLocationsMask() const
263 {
264 return mActiveAttribLocationsMask;
265 }
Corentin Walleze7557742017-06-01 13:09:57 -0400266 DrawBufferMask getActiveOutputVariables() const { return mActiveOutputVariables; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400267 const std::vector<sh::OutputVariable> &getOutputVariables() const { return mOutputVariables; }
jchen1015015f72017-03-16 13:54:21 +0800268 const std::map<int, VariableLocation> &getOutputLocations() const { return mOutputLocations; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400269 const std::vector<LinkedUniform> &getUniforms() const { return mUniforms; }
270 const std::vector<VariableLocation> &getUniformLocations() const { return mUniformLocations; }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800271 const std::vector<InterfaceBlock> &getUniformBlocks() const { return mUniformBlocks; }
272 const std::vector<InterfaceBlock> &getShaderStorageBlocks() const
273 {
274 return mShaderStorageBlocks;
275 }
Jamie Madille7d84322017-01-10 18:21:59 -0500276 const std::vector<SamplerBinding> &getSamplerBindings() const { return mSamplerBindings; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800277 const std::vector<ImageBinding> &getImageBindings() const { return mImageBindings; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400278 const sh::WorkGroupSize &getComputeShaderLocalSize() const { return mComputeShaderLocalSize; }
279 const RangeUI &getSamplerUniformRange() const { return mSamplerUniformRange; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800280 const RangeUI &getImageUniformRange() const { return mImageUniformRange; }
jchen10eaef1e52017-06-13 10:44:11 +0800281 const RangeUI &getAtomicCounterUniformRange() const { return mAtomicCounterUniformRange; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400282
Jamie Madill4f86d052017-06-05 12:59:26 -0400283 const std::vector<TransformFeedbackVarying> &getLinkedTransformFeedbackVaryings() const
284 {
285 return mLinkedTransformFeedbackVaryings;
286 }
jchen10eaef1e52017-06-13 10:44:11 +0800287 const std::vector<AtomicCounterBuffer> &getAtomicCounterBuffers() const
288 {
289 return mAtomicCounterBuffers;
290 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400291
Jamie Madill48ef11b2016-04-27 15:21:52 -0400292 GLint getUniformLocation(const std::string &name) const;
Jamie Madille7d84322017-01-10 18:21:59 -0500293 GLuint getUniformIndexFromName(const std::string &name) const;
294 GLuint getUniformIndexFromLocation(GLint location) const;
295 Optional<GLuint> getSamplerIndex(GLint location) const;
296 bool isSamplerUniformIndex(GLuint index) const;
297 GLuint getSamplerIndexFromUniformIndex(GLuint uniformIndex) const;
Jamie Madill34ca4f52017-06-13 11:49:39 -0400298 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400299
Martin Radev4e619f52017-08-09 11:50:06 +0300300 int getNumViews() const { return mNumViews; }
301 bool usesMultiview() const { return mNumViews != -1; }
302
Jamie Madill48ef11b2016-04-27 15:21:52 -0400303 private:
Jamie Madill4f86d052017-06-05 12:59:26 -0400304 friend class MemoryProgramCache;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400305 friend class Program;
306
307 std::string mLabel;
308
Martin Radev4c4c8e72016-08-04 12:25:34 +0300309 sh::WorkGroupSize mComputeShaderLocalSize;
310
Jamie Madill48ef11b2016-04-27 15:21:52 -0400311 Shader *mAttachedFragmentShader;
312 Shader *mAttachedVertexShader;
Martin Radev4c4c8e72016-08-04 12:25:34 +0300313 Shader *mAttachedComputeShader;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400314
315 std::vector<std::string> mTransformFeedbackVaryingNames;
jchen10a9042d32017-03-17 08:50:45 +0800316 std::vector<TransformFeedbackVarying> mLinkedTransformFeedbackVaryings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400317 GLenum mTransformFeedbackBufferMode;
318
jchen107a20b972017-06-13 14:25:26 +0800319 // For faster iteration on the blocks currently being bound.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400320 UniformBlockBindingMask mActiveUniformBlockBindings;
321
322 std::vector<sh::Attribute> mAttributes;
Jamie Madill6de51852017-04-12 09:53:01 -0400323 angle::BitSet<MAX_VERTEX_ATTRIBS> mActiveAttribLocationsMask;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400324
325 // Uniforms are sorted in order:
jchen10eaef1e52017-06-13 10:44:11 +0800326 // 1. Non-opaque uniforms
Jamie Madill48ef11b2016-04-27 15:21:52 -0400327 // 2. Sampler uniforms
jchen10eaef1e52017-06-13 10:44:11 +0800328 // 3. Image uniforms
329 // 4. Atomic counter uniforms
330 // 5. Uniform block uniforms
331 // This makes opaque uniform validation easier, since we don't need a separate list.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400332 std::vector<LinkedUniform> mUniforms;
333 std::vector<VariableLocation> mUniformLocations;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800334 std::vector<InterfaceBlock> mUniformBlocks;
335 std::vector<InterfaceBlock> mShaderStorageBlocks;
jchen10eaef1e52017-06-13 10:44:11 +0800336 std::vector<AtomicCounterBuffer> mAtomicCounterBuffers;
Jamie Madille7d84322017-01-10 18:21:59 -0500337 RangeUI mSamplerUniformRange;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800338 RangeUI mImageUniformRange;
jchen10eaef1e52017-06-13 10:44:11 +0800339 RangeUI mAtomicCounterUniformRange;
Jamie Madille7d84322017-01-10 18:21:59 -0500340
341 // An array of the samplers that are used by the program
342 std::vector<gl::SamplerBinding> mSamplerBindings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400343
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800344 // An array of the images that are used by the program
345 std::vector<gl::ImageBinding> mImageBindings;
346
jchen1015015f72017-03-16 13:54:21 +0800347 std::vector<sh::OutputVariable> mOutputVariables;
jchen1015015f72017-03-16 13:54:21 +0800348 std::map<int, VariableLocation> mOutputLocations;
Corentin Walleze7557742017-06-01 13:09:57 -0400349 DrawBufferMask mActiveOutputVariables;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400350
Geoff Lange0cff192017-05-30 13:04:56 -0400351 // Fragment output variable base types: FLOAT, INT, or UINT. Ordered by location.
352 std::vector<GLenum> mOutputVariableTypes;
353
Jamie Madill48ef11b2016-04-27 15:21:52 -0400354 bool mBinaryRetrieveableHint;
Yunchao He61afff12017-03-14 15:34:03 +0800355 bool mSeparable;
Martin Radev7cf61662017-07-26 17:10:53 +0300356
357 // ANGLE_multiview.
358 int mNumViews;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400359};
360
Geoff Lang70d0f492015-12-10 17:45:46 -0500361class Program final : angle::NonCopyable, public LabeledObject
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000362{
363 public:
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500364 Program(rx::GLImplFactory *factory, ShaderProgramManager *manager, GLuint handle);
Jamie Madill4928b7c2017-06-20 12:57:39 -0400365 void onDestroy(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000366
Geoff Lang7dd2e102014-11-10 15:19:26 -0500367 GLuint id() const { return mHandle; }
368
Geoff Lang70d0f492015-12-10 17:45:46 -0500369 void setLabel(const std::string &label) override;
370 const std::string &getLabel() const override;
371
Geoff Lang47110bf2016-04-20 11:13:22 -0700372 rx::ProgramImpl *getImplementation() const { return mProgram; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500373
Jamie Madillef300b12016-10-07 15:12:09 -0400374 void attachShader(Shader *shader);
Jamie Madillc1d770e2017-04-13 17:31:24 -0400375 void detachShader(const Context *context, Shader *shader);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000376 int getAttachedShadersCount() const;
377
Jamie Madillef300b12016-10-07 15:12:09 -0400378 const Shader *getAttachedVertexShader() const { return mState.mAttachedVertexShader; }
379 const Shader *getAttachedFragmentShader() const { return mState.mAttachedFragmentShader; }
380 const Shader *getAttachedComputeShader() const { return mState.mAttachedComputeShader; }
381
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000382 void bindAttributeLocation(GLuint index, const char *name);
Geoff Langd8605522016-04-13 10:19:12 -0400383 void bindUniformLocation(GLuint index, const char *name);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000384
Sami Väisänen46eaa942016-06-29 10:26:37 +0300385 // CHROMIUM_path_rendering
Jamie Madillbd044ed2017-06-05 12:59:21 -0400386 BindingInfo getFragmentInputBindingInfo(const Context *context, GLint index) const;
Sami Väisänen46eaa942016-06-29 10:26:37 +0300387 void bindFragmentInputLocation(GLint index, const char *name);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400388 void pathFragmentInputGen(const Context *context,
389 GLint index,
Sami Väisänen46eaa942016-06-29 10:26:37 +0300390 GLenum genMode,
391 GLint components,
392 const GLfloat *coeffs);
393
Jamie Madill8ecf7f92017-01-13 17:29:52 -0500394 Error link(const gl::Context *context);
Geoff Lange1a27752015-10-05 13:16:04 -0400395 bool isLinked() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500396
Jamie Madilla2c74982016-12-12 11:20:42 -0500397 Error loadBinary(const Context *context,
398 GLenum binaryFormat,
399 const void *binary,
400 GLsizei length);
401 Error saveBinary(const Context *context,
402 GLenum *binaryFormat,
403 void *binary,
404 GLsizei bufSize,
405 GLsizei *length) const;
Jamie Madillffe00c02017-06-27 16:26:55 -0400406 GLint getBinaryLength(const Context *context) const;
Geoff Langc5629752015-12-07 16:29:04 -0500407 void setBinaryRetrievableHint(bool retrievable);
408 bool getBinaryRetrievableHint() const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000409
Yunchao He61afff12017-03-14 15:34:03 +0800410 void setSeparable(bool separable);
411 bool isSeparable() const;
412
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000413 int getInfoLogLength() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400414 void getInfoLog(GLsizei bufSize, GLsizei *length, char *infoLog) const;
415 void getAttachedShaders(GLsizei maxCount, GLsizei *count, GLuint *shaders) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000416
Geoff Lange1a27752015-10-05 13:16:04 -0400417 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill63805b42015-08-25 13:17:39 -0400418 bool isAttribLocationActive(size_t attribLocation) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500419
jchen10fd7c3b52017-03-21 15:36:03 +0800420 void getActiveAttribute(GLuint index,
421 GLsizei bufsize,
422 GLsizei *length,
423 GLint *size,
424 GLenum *type,
425 GLchar *name) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400426 GLint getActiveAttributeCount() const;
427 GLint getActiveAttributeMaxLength() const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400428 const std::vector<sh::Attribute> &getAttributes() const { return mState.mAttributes; }
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000429
Geoff Lang7dd2e102014-11-10 15:19:26 -0500430 GLint getFragDataLocation(const std::string &name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800431 size_t getOutputResourceCount() const;
Geoff Lange0cff192017-05-30 13:04:56 -0400432 const std::vector<GLenum> &getOutputVariableTypes() const
433 {
434 return mState.mOutputVariableTypes;
435 }
Corentin Wallezdb9e5d32017-06-12 12:05:45 -0700436 DrawBufferMask getActiveOutputVariables() const { return mState.mActiveOutputVariables; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500437
Geoff Lange1a27752015-10-05 13:16:04 -0400438 void getActiveUniform(GLuint index,
439 GLsizei bufsize,
440 GLsizei *length,
441 GLint *size,
442 GLenum *type,
443 GLchar *name) const;
444 GLint getActiveUniformCount() const;
445 GLint getActiveUniformMaxLength() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500446 GLint getActiveUniformi(GLuint index, GLenum pname) const;
447 bool isValidUniformLocation(GLint location) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400448 const LinkedUniform &getUniformByLocation(GLint location) const;
Jamie Madillac4e9c32017-01-13 14:07:12 -0500449 const VariableLocation &getUniformLocation(GLint location) const;
450 const std::vector<VariableLocation> &getUniformLocations() const;
451 const LinkedUniform &getUniformByIndex(GLuint index) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000452
Jamie Madill81c2e252017-09-09 23:32:46 -0400453 enum SetUniformResult
454 {
455 SamplerChanged,
456 NoSamplerChange,
457 };
458
Jamie Madill62d31cb2015-09-11 13:25:51 -0400459 GLint getUniformLocation(const std::string &name) const;
460 GLuint getUniformIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500461 void setUniform1fv(GLint location, GLsizei count, const GLfloat *v);
462 void setUniform2fv(GLint location, GLsizei count, const GLfloat *v);
463 void setUniform3fv(GLint location, GLsizei count, const GLfloat *v);
464 void setUniform4fv(GLint location, GLsizei count, const GLfloat *v);
Jamie Madill81c2e252017-09-09 23:32:46 -0400465 SetUniformResult setUniform1iv(GLint location, GLsizei count, const GLint *v);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500466 void setUniform2iv(GLint location, GLsizei count, const GLint *v);
467 void setUniform3iv(GLint location, GLsizei count, const GLint *v);
468 void setUniform4iv(GLint location, GLsizei count, const GLint *v);
469 void setUniform1uiv(GLint location, GLsizei count, const GLuint *v);
470 void setUniform2uiv(GLint location, GLsizei count, const GLuint *v);
471 void setUniform3uiv(GLint location, GLsizei count, const GLuint *v);
472 void setUniform4uiv(GLint location, GLsizei count, const GLuint *v);
473 void setUniformMatrix2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
474 void setUniformMatrix3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
475 void setUniformMatrix4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
476 void setUniformMatrix2x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
477 void setUniformMatrix3x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
478 void setUniformMatrix2x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
479 void setUniformMatrix4x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
480 void setUniformMatrix3x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
481 void setUniformMatrix4x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
482
Jamie Madill54164b02017-08-28 15:17:37 -0400483 void getUniformfv(const Context *context, GLint location, GLfloat *params) const;
484 void getUniformiv(const Context *context, GLint location, GLint *params) const;
485 void getUniformuiv(const Context *context, GLint location, GLuint *params) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500486
Geoff Lang7dd2e102014-11-10 15:19:26 -0500487 void getActiveUniformBlockName(GLuint uniformBlockIndex, GLsizei bufSize, GLsizei *length, GLchar *uniformBlockName) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400488 GLuint getActiveUniformBlockCount() const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800489 GLuint getActiveShaderStorageBlockCount() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400490 GLint getActiveUniformBlockMaxLength() const;
shannonwoods@chromium.orge684b582013-05-30 00:07:42 +0000491
Geoff Lange1a27752015-10-05 13:16:04 -0400492 GLuint getUniformBlockIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500493
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000494 void bindUniformBlock(GLuint uniformBlockIndex, GLuint uniformBlockBinding);
495 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800496 GLuint getShaderStorageBlockBinding(GLuint shaderStorageBlockIndex) const;
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000497
Jiajia Qin729b2c62017-08-14 09:36:11 +0800498 const InterfaceBlock &getUniformBlockByIndex(GLuint index) const;
Gregoire Payen de La Garanderie68694e92015-03-24 14:03:37 +0000499
Geoff Lang48dcae72014-02-05 16:28:24 -0500500 void setTransformFeedbackVaryings(GLsizei count, const GLchar *const *varyings, GLenum bufferMode);
501 void getTransformFeedbackVarying(GLuint index, GLsizei bufSize, GLsizei *length, GLsizei *size, GLenum *type, GLchar *name) const;
Geoff Lang1b6edcb2014-02-03 14:27:56 -0500502 GLsizei getTransformFeedbackVaryingCount() const;
503 GLsizei getTransformFeedbackVaryingMaxLength() const;
504 GLenum getTransformFeedbackBufferMode() const;
505
Frank Henigmanfccbac22017-05-28 17:29:26 -0400506 static bool linkValidateInterfaceBlockFields(InfoLog &infoLog,
507 const std::string &uniformName,
508 const sh::InterfaceBlockField &vertexUniform,
509 const sh::InterfaceBlockField &fragmentUniform,
510 bool webglCompatibility);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500511
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000512 void addRef();
Jamie Madill6c1f6712017-02-14 19:08:04 -0500513 void release(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000514 unsigned int getRefCount() const;
515 void flagForDeletion();
516 bool isFlaggedForDeletion() const;
517
Brandon Jones43a53e22014-08-28 16:23:22 -0700518 void validate(const Caps &caps);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500519 bool validateSamplers(InfoLog *infoLog, const Caps &caps);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000520 bool isValidated() const;
Jamie Madilla4595b82017-01-11 17:36:34 -0500521 bool samplesFromTexture(const gl::State &state, GLuint textureID) const;
apatrick@chromium.org90080e32012-07-09 22:15:33 +0000522
Jamie Madill63805b42015-08-25 13:17:39 -0400523 const AttributesMask &getActiveAttribLocationsMask() const
524 {
Jamie Madill48ef11b2016-04-27 15:21:52 -0400525 return mState.mActiveAttribLocationsMask;
Jamie Madill63805b42015-08-25 13:17:39 -0400526 }
527
Jamie Madille7d84322017-01-10 18:21:59 -0500528 const std::vector<SamplerBinding> &getSamplerBindings() const
529 {
530 return mState.mSamplerBindings;
531 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800532
533 const std::vector<ImageBinding> &getImageBindings() const { return mState.mImageBindings; }
534
Jamie Madilldf68a6f2017-01-13 17:29:53 -0500535 const ProgramState &getState() const { return mState; }
Jamie Madille7d84322017-01-10 18:21:59 -0500536
Olli Etuahob78707c2017-03-09 15:03:11 +0000537 static bool linkValidateVariablesBase(InfoLog &infoLog,
538 const std::string &variableName,
539 const sh::ShaderVariable &vertexVariable,
540 const sh::ShaderVariable &fragmentVariable,
541 bool validatePrecision);
542
jchen1015015f72017-03-16 13:54:21 +0800543 GLuint getInputResourceIndex(const GLchar *name) const;
544 GLuint getOutputResourceIndex(const GLchar *name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800545 void getInputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
546 void getOutputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
jchen10880683b2017-04-12 16:21:55 +0800547 const sh::Attribute &getInputResource(GLuint index) const;
548 const sh::OutputVariable &getOutputResource(GLuint index) const;
jchen1015015f72017-03-16 13:54:21 +0800549
Geoff Langd8605522016-04-13 10:19:12 -0400550 class Bindings final : angle::NonCopyable
551 {
552 public:
553 void bindLocation(GLuint index, const std::string &name);
554 int getBinding(const std::string &name) const;
555
556 typedef std::unordered_map<std::string, GLuint>::const_iterator const_iterator;
557 const_iterator begin() const;
558 const_iterator end() const;
559
560 private:
561 std::unordered_map<std::string, GLuint> mBindings;
562 };
563
Jamie Madill32447362017-06-28 14:53:52 -0400564 const Bindings &getAttributeBindings() const { return mAttributeBindings; }
565 const Bindings &getUniformLocationBindings() const { return mUniformLocationBindings; }
566 const Bindings &getFragmentInputBindings() const { return mFragmentInputBindings; }
567
Martin Radev4e619f52017-08-09 11:50:06 +0300568 int getNumViews() const { return mState.getNumViews(); }
569 bool usesMultiview() const { return mState.usesMultiview(); }
Martin Radev7cf61662017-07-26 17:10:53 +0300570
Olli Etuahob78707c2017-03-09 15:03:11 +0000571 private:
Jamie Madill4928b7c2017-06-20 12:57:39 -0400572 ~Program();
573
Jamie Madill192745a2016-12-22 15:58:21 -0500574 struct VaryingRef
575 {
576 const sh::Varying *get() const { return vertex ? vertex : fragment; }
577
578 const sh::Varying *vertex = nullptr;
579 const sh::Varying *fragment = nullptr;
580 };
581
582 using MergedVaryings = std::map<std::string, VaryingRef>;
583
Jamie Madill6c1f6712017-02-14 19:08:04 -0500584 void unlink();
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000585
Jamie Madillbd044ed2017-06-05 12:59:21 -0400586 bool linkAttributes(const Context *context, InfoLog &infoLog);
Martin Radev4c4c8e72016-08-04 12:25:34 +0300587 bool validateVertexAndFragmentInterfaceBlocks(
588 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
589 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400590 InfoLog &infoLog,
591 bool webglCompatibility) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800592 bool linkInterfaceBlocks(const Context *context, InfoLog &infoLog);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400593 bool linkVaryings(const Context *context, InfoLog &infoLog) const;
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000594
Jamie Madillbd044ed2017-06-05 12:59:21 -0400595 bool linkUniforms(const Context *context,
596 InfoLog &infoLog,
597 const Bindings &uniformLocationBindings);
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800598 void linkSamplerAndImageBindings();
jchen10eaef1e52017-06-13 10:44:11 +0800599 bool linkAtomicCounterBuffers();
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000600
Jamie Madilla2c74982016-12-12 11:20:42 -0500601 bool areMatchingInterfaceBlocks(InfoLog &infoLog,
Martin Radev4c4c8e72016-08-04 12:25:34 +0300602 const sh::InterfaceBlock &vertexInterfaceBlock,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400603 const sh::InterfaceBlock &fragmentInterfaceBlock,
604 bool webglCompatibility) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500605
Yuly Novikova1f6dc92016-06-15 23:27:04 -0400606 static bool linkValidateVaryings(InfoLog &infoLog,
607 const std::string &varyingName,
608 const sh::Varying &vertexVarying,
609 const sh::Varying &fragmentVarying,
610 int shaderVersion);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400611 bool linkValidateBuiltInVaryings(const Context *context, InfoLog &infoLog) const;
jchen10a9042d32017-03-17 08:50:45 +0800612 bool linkValidateTransformFeedback(const gl::Context *context,
613 InfoLog &infoLog,
Jamie Madill192745a2016-12-22 15:58:21 -0500614 const MergedVaryings &linkedVaryings,
Jamie Madillccdf74b2015-08-18 10:46:12 -0400615 const Caps &caps) const;
Yuly Novikovcaa5cda2017-06-15 21:14:03 -0400616 bool linkValidateGlobalNames(const Context *context, InfoLog &infoLog) const;
Jamie Madillccdf74b2015-08-18 10:46:12 -0400617
Jamie Madill192745a2016-12-22 15:58:21 -0500618 void gatherTransformFeedbackVaryings(const MergedVaryings &varyings);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500619
Jamie Madillbd044ed2017-06-05 12:59:21 -0400620 MergedVaryings getMergedVaryings(const Context *context) const;
Jamie Madill192745a2016-12-22 15:58:21 -0500621 std::vector<PackedVarying> getPackedVaryings(const MergedVaryings &mergedVaryings) const;
Jamie Madillbd044ed2017-06-05 12:59:21 -0400622 void linkOutputVariables(const Context *context);
Jamie Madillccdf74b2015-08-18 10:46:12 -0400623
Olli Etuaho48fed632017-03-16 12:05:30 +0000624 void setUniformValuesFromBindingQualifiers();
625
jchen10eaef1e52017-06-13 10:44:11 +0800626 void gatherAtomicCounterBuffers();
Jiajia Qin729b2c62017-08-14 09:36:11 +0800627 void gatherComputeBlockInfo(const std::vector<sh::InterfaceBlock> &computeBlocks);
628 void gatherVertexAndFragmentBlockInfo(
629 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
630 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400631 void gatherInterfaceBlockInfo(const Context *context);
Jamie Madill4a3c2342015-10-08 12:58:45 -0400632 template <typename VarT>
633 void defineUniformBlockMembers(const std::vector<VarT> &fields,
634 const std::string &prefix,
Olli Etuaho855d9642017-05-17 14:05:06 +0300635 const std::string &mappedPrefix,
Jamie Madill4a3c2342015-10-08 12:58:45 -0400636 int blockIndex);
637
Jiajia Qin729b2c62017-08-14 09:36:11 +0800638 void defineInterfaceBlock(const sh::InterfaceBlock &interfaceBlock, GLenum shaderType);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400639
Corentin Wallez8b7d8142016-11-15 13:40:37 -0500640 // Both these function update the cached uniform values and return a modified "count"
641 // so that the uniform update doesn't overflow the uniform.
Jamie Madill62d31cb2015-09-11 13:25:51 -0400642 template <typename T>
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400643 GLsizei clampUniformCount(const VariableLocation &locationInfo,
644 GLsizei count,
645 int vectorSize,
Jamie Madille7d84322017-01-10 18:21:59 -0500646 const T *v);
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400647 template <size_t cols, size_t rows, typename T>
648 GLsizei clampMatrixUniformCount(GLint location, GLsizei count, GLboolean transpose, const T *v);
649
650 void updateSamplerUniform(const VariableLocation &locationInfo,
651 GLsizei clampedCount,
652 const GLint *v);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400653
654 template <typename DestT>
Jamie Madill54164b02017-08-28 15:17:37 -0400655 void getUniformInternal(const Context *context,
656 DestT *dataOut,
657 GLint location,
658 GLenum nativeType,
659 int components) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400660
Jamie Madill48ef11b2016-04-27 15:21:52 -0400661 ProgramState mState;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500662 rx::ProgramImpl *mProgram;
663
Geoff Lang7dd2e102014-11-10 15:19:26 -0500664 bool mValidated;
665
Geoff Langd8605522016-04-13 10:19:12 -0400666 Bindings mAttributeBindings;
Olli Etuaho4a92ceb2017-02-19 17:51:24 +0000667
668 // Note that this has nothing to do with binding layout qualifiers that can be set for some
669 // uniforms in GLES3.1+. It is used to pre-set the location of uniforms.
670 Bindings mUniformLocationBindings;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000671
Sami Väisänen46eaa942016-06-29 10:26:37 +0300672 // CHROMIUM_path_rendering
673 Bindings mFragmentInputBindings;
674
daniel@transgaming.com716056c2012-07-24 18:38:59 +0000675 bool mLinked;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000676 bool mDeleteStatus; // Flag to indicate that the program can be deleted when no longer in use
daniel@transgaming.com4fa08332010-05-11 02:29:27 +0000677
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000678 unsigned int mRefCount;
679
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500680 ShaderProgramManager *mResourceManager;
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000681 const GLuint mHandle;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000682
683 InfoLog mInfoLog;
Jamie Madill3d3d2f22015-09-23 16:47:51 -0400684
685 // Cache for sampler validation
686 Optional<bool> mCachedValidateSamplersResult;
687 std::vector<GLenum> mTextureUnitTypesCache;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000688};
Jamie Madilla2c74982016-12-12 11:20:42 -0500689} // namespace gl
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000690
Geoff Lang0a73dd82014-11-19 16:18:08 -0500691#endif // LIBANGLE_PROGRAM_H_