blob: ca9e8e019932eca621baa7c212aeca97ad9fd8cb [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{
138 VariableLocation();
139 VariableLocation(const std::string &name, unsigned int element, unsigned int index);
140
141 std::string name;
142 unsigned int element;
143 unsigned int index;
Geoff Langd8605522016-04-13 10:19:12 -0400144
Jamie Madillfe8b5982017-09-07 17:00:18 -0400145 // If used is false, it means this location is only used to fill an empty space in an array,
146 // and there is no corresponding uniform variable for this location. It can also mean the
147 // uniform was optimized out by the implementation.
Geoff Langd8605522016-04-13 10:19:12 -0400148 bool used;
149
150 // If this location was bound to an unreferenced uniform. Setting data on this uniform is a
151 // no-op.
152 bool ignored;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500153};
154
Sami Väisänen46eaa942016-06-29 10:26:37 +0300155// Information about a variable binding.
156// Currently used by CHROMIUM_path_rendering
157struct BindingInfo
158{
159 // The type of binding, for example GL_FLOAT_VEC3.
160 // This can be GL_NONE if the variable is optimized away.
161 GLenum type;
162
163 // This is the name of the variable in
164 // the translated shader program. Note that
165 // this can be empty in the case where the
166 // variable has been optimized away.
167 std::string name;
168
169 // True if the binding is valid, otherwise false.
170 bool valid;
171};
172
Jamie Madille7d84322017-01-10 18:21:59 -0500173// This small structure encapsulates binding sampler uniforms to active GL textures.
174struct SamplerBinding
175{
Jamie Madill54164b02017-08-28 15:17:37 -0400176 SamplerBinding(GLenum textureTypeIn, size_t elementCount, bool unreferenced)
177 : textureType(textureTypeIn), boundTextureUnits(elementCount, 0), unreferenced(unreferenced)
Jamie Madille7d84322017-01-10 18:21:59 -0500178 {
179 }
180
181 // Necessary for retrieving active textures from the GL state.
182 GLenum textureType;
183
184 // List of all textures bound to this sampler, of type textureType.
185 std::vector<GLuint> boundTextureUnits;
Jamie Madill54164b02017-08-28 15:17:37 -0400186
187 // A note if this sampler is an unreferenced uniform.
188 bool unreferenced;
Jamie Madille7d84322017-01-10 18:21:59 -0500189};
190
jchen10a9042d32017-03-17 08:50:45 +0800191// A varying with tranform feedback enabled. If it's an array, either the whole array or one of its
192// elements specified by 'arrayIndex' can set to be enabled.
193struct TransformFeedbackVarying : public sh::Varying
194{
195 TransformFeedbackVarying(const sh::Varying &varyingIn, GLuint index)
196 : sh::Varying(varyingIn), arrayIndex(index)
197 {
198 }
199 std::string nameWithArrayIndex() const
200 {
201 std::stringstream fullNameStr;
202 fullNameStr << name;
203 if (arrayIndex != GL_INVALID_INDEX)
204 {
205 fullNameStr << "[" << arrayIndex << "]";
206 }
207 return fullNameStr.str();
208 }
209 GLsizei size() const { return (arrayIndex == GL_INVALID_INDEX ? elementCount() : 1); }
210
211 GLuint arrayIndex;
212};
213
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800214struct ImageBinding
215{
Xinghua Cao0328b572017-06-26 15:51:36 +0800216 ImageBinding(size_t count) : boundImageUnits(count, 0) {}
217 ImageBinding(GLuint imageUnit, size_t count)
218 {
219 for (size_t index = 0; index < count; ++index)
220 {
221 boundImageUnits.push_back(imageUnit + static_cast<GLuint>(index));
222 }
223 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800224
Xinghua Cao0328b572017-06-26 15:51:36 +0800225 std::vector<GLuint> boundImageUnits;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800226};
227
Jamie Madill48ef11b2016-04-27 15:21:52 -0400228class ProgramState final : angle::NonCopyable
229{
230 public:
231 ProgramState();
232 ~ProgramState();
233
234 const std::string &getLabel();
235
Jamie Madillbd044ed2017-06-05 12:59:21 -0400236 Shader *getAttachedVertexShader() const { return mAttachedVertexShader; }
237 Shader *getAttachedFragmentShader() const { return mAttachedFragmentShader; }
238 Shader *getAttachedComputeShader() const { return mAttachedComputeShader; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400239 const std::vector<std::string> &getTransformFeedbackVaryingNames() const
240 {
241 return mTransformFeedbackVaryingNames;
242 }
243 GLint getTransformFeedbackBufferMode() const { return mTransformFeedbackBufferMode; }
244 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const
245 {
jchen107a20b972017-06-13 14:25:26 +0800246 ASSERT(uniformBlockIndex < mUniformBlocks.size());
247 return mUniformBlocks[uniformBlockIndex].binding;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400248 }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800249 GLuint getShaderStorageBlockBinding(GLuint blockIndex) const
250 {
251 ASSERT(blockIndex < mShaderStorageBlocks.size());
252 return mShaderStorageBlocks[blockIndex].binding;
253 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400254 const UniformBlockBindingMask &getActiveUniformBlockBindingsMask() const
255 {
256 return mActiveUniformBlockBindings;
257 }
258 const std::vector<sh::Attribute> &getAttributes() const { return mAttributes; }
259 const AttributesMask &getActiveAttribLocationsMask() const
260 {
261 return mActiveAttribLocationsMask;
262 }
Corentin Walleze7557742017-06-01 13:09:57 -0400263 DrawBufferMask getActiveOutputVariables() const { return mActiveOutputVariables; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400264 const std::vector<sh::OutputVariable> &getOutputVariables() const { return mOutputVariables; }
jchen1015015f72017-03-16 13:54:21 +0800265 const std::map<int, VariableLocation> &getOutputLocations() const { return mOutputLocations; }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400266 const std::vector<LinkedUniform> &getUniforms() const { return mUniforms; }
267 const std::vector<VariableLocation> &getUniformLocations() const { return mUniformLocations; }
Jiajia Qin729b2c62017-08-14 09:36:11 +0800268 const std::vector<InterfaceBlock> &getUniformBlocks() const { return mUniformBlocks; }
269 const std::vector<InterfaceBlock> &getShaderStorageBlocks() const
270 {
271 return mShaderStorageBlocks;
272 }
Jamie Madille7d84322017-01-10 18:21:59 -0500273 const std::vector<SamplerBinding> &getSamplerBindings() const { return mSamplerBindings; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800274 const std::vector<ImageBinding> &getImageBindings() const { return mImageBindings; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400275 const sh::WorkGroupSize &getComputeShaderLocalSize() const { return mComputeShaderLocalSize; }
276 const RangeUI &getSamplerUniformRange() const { return mSamplerUniformRange; }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800277 const RangeUI &getImageUniformRange() const { return mImageUniformRange; }
jchen10eaef1e52017-06-13 10:44:11 +0800278 const RangeUI &getAtomicCounterUniformRange() const { return mAtomicCounterUniformRange; }
Jamie Madill4f86d052017-06-05 12:59:26 -0400279
Jamie Madill4f86d052017-06-05 12:59:26 -0400280 const std::vector<TransformFeedbackVarying> &getLinkedTransformFeedbackVaryings() const
281 {
282 return mLinkedTransformFeedbackVaryings;
283 }
jchen10eaef1e52017-06-13 10:44:11 +0800284 const std::vector<AtomicCounterBuffer> &getAtomicCounterBuffers() const
285 {
286 return mAtomicCounterBuffers;
287 }
Jamie Madill48ef11b2016-04-27 15:21:52 -0400288
Jamie Madill48ef11b2016-04-27 15:21:52 -0400289 GLint getUniformLocation(const std::string &name) const;
Jamie Madille7d84322017-01-10 18:21:59 -0500290 GLuint getUniformIndexFromName(const std::string &name) const;
291 GLuint getUniformIndexFromLocation(GLint location) const;
292 Optional<GLuint> getSamplerIndex(GLint location) const;
293 bool isSamplerUniformIndex(GLuint index) const;
294 GLuint getSamplerIndexFromUniformIndex(GLuint uniformIndex) const;
Jamie Madill34ca4f52017-06-13 11:49:39 -0400295 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400296
Martin Radev4e619f52017-08-09 11:50:06 +0300297 int getNumViews() const { return mNumViews; }
298 bool usesMultiview() const { return mNumViews != -1; }
299
Jamie Madill48ef11b2016-04-27 15:21:52 -0400300 private:
Jamie Madill4f86d052017-06-05 12:59:26 -0400301 friend class MemoryProgramCache;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400302 friend class Program;
303
304 std::string mLabel;
305
Martin Radev4c4c8e72016-08-04 12:25:34 +0300306 sh::WorkGroupSize mComputeShaderLocalSize;
307
Jamie Madill48ef11b2016-04-27 15:21:52 -0400308 Shader *mAttachedFragmentShader;
309 Shader *mAttachedVertexShader;
Martin Radev4c4c8e72016-08-04 12:25:34 +0300310 Shader *mAttachedComputeShader;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400311
312 std::vector<std::string> mTransformFeedbackVaryingNames;
jchen10a9042d32017-03-17 08:50:45 +0800313 std::vector<TransformFeedbackVarying> mLinkedTransformFeedbackVaryings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400314 GLenum mTransformFeedbackBufferMode;
315
jchen107a20b972017-06-13 14:25:26 +0800316 // For faster iteration on the blocks currently being bound.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400317 UniformBlockBindingMask mActiveUniformBlockBindings;
318
319 std::vector<sh::Attribute> mAttributes;
Jamie Madill6de51852017-04-12 09:53:01 -0400320 angle::BitSet<MAX_VERTEX_ATTRIBS> mActiveAttribLocationsMask;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400321
322 // Uniforms are sorted in order:
jchen10eaef1e52017-06-13 10:44:11 +0800323 // 1. Non-opaque uniforms
Jamie Madill48ef11b2016-04-27 15:21:52 -0400324 // 2. Sampler uniforms
jchen10eaef1e52017-06-13 10:44:11 +0800325 // 3. Image uniforms
326 // 4. Atomic counter uniforms
327 // 5. Uniform block uniforms
328 // This makes opaque uniform validation easier, since we don't need a separate list.
Jamie Madill48ef11b2016-04-27 15:21:52 -0400329 std::vector<LinkedUniform> mUniforms;
330 std::vector<VariableLocation> mUniformLocations;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800331 std::vector<InterfaceBlock> mUniformBlocks;
332 std::vector<InterfaceBlock> mShaderStorageBlocks;
jchen10eaef1e52017-06-13 10:44:11 +0800333 std::vector<AtomicCounterBuffer> mAtomicCounterBuffers;
Jamie Madille7d84322017-01-10 18:21:59 -0500334 RangeUI mSamplerUniformRange;
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800335 RangeUI mImageUniformRange;
jchen10eaef1e52017-06-13 10:44:11 +0800336 RangeUI mAtomicCounterUniformRange;
Jamie Madille7d84322017-01-10 18:21:59 -0500337
338 // An array of the samplers that are used by the program
339 std::vector<gl::SamplerBinding> mSamplerBindings;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400340
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800341 // An array of the images that are used by the program
342 std::vector<gl::ImageBinding> mImageBindings;
343
jchen1015015f72017-03-16 13:54:21 +0800344 std::vector<sh::OutputVariable> mOutputVariables;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400345 // TODO(jmadill): use unordered/hash map when available
jchen1015015f72017-03-16 13:54:21 +0800346 std::map<int, VariableLocation> mOutputLocations;
Corentin Walleze7557742017-06-01 13:09:57 -0400347 DrawBufferMask mActiveOutputVariables;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400348
Geoff Lange0cff192017-05-30 13:04:56 -0400349 // Fragment output variable base types: FLOAT, INT, or UINT. Ordered by location.
350 std::vector<GLenum> mOutputVariableTypes;
351
Jamie Madill48ef11b2016-04-27 15:21:52 -0400352 bool mBinaryRetrieveableHint;
Yunchao He61afff12017-03-14 15:34:03 +0800353 bool mSeparable;
Martin Radev7cf61662017-07-26 17:10:53 +0300354
355 // ANGLE_multiview.
356 int mNumViews;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400357};
358
Geoff Lang70d0f492015-12-10 17:45:46 -0500359class Program final : angle::NonCopyable, public LabeledObject
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000360{
361 public:
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500362 Program(rx::GLImplFactory *factory, ShaderProgramManager *manager, GLuint handle);
Jamie Madill4928b7c2017-06-20 12:57:39 -0400363 void onDestroy(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000364
Geoff Lang7dd2e102014-11-10 15:19:26 -0500365 GLuint id() const { return mHandle; }
366
Geoff Lang70d0f492015-12-10 17:45:46 -0500367 void setLabel(const std::string &label) override;
368 const std::string &getLabel() const override;
369
Geoff Lang47110bf2016-04-20 11:13:22 -0700370 rx::ProgramImpl *getImplementation() const { return mProgram; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500371
Jamie Madillef300b12016-10-07 15:12:09 -0400372 void attachShader(Shader *shader);
Jamie Madillc1d770e2017-04-13 17:31:24 -0400373 void detachShader(const Context *context, Shader *shader);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000374 int getAttachedShadersCount() const;
375
Jamie Madillef300b12016-10-07 15:12:09 -0400376 const Shader *getAttachedVertexShader() const { return mState.mAttachedVertexShader; }
377 const Shader *getAttachedFragmentShader() const { return mState.mAttachedFragmentShader; }
378 const Shader *getAttachedComputeShader() const { return mState.mAttachedComputeShader; }
379
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000380 void bindAttributeLocation(GLuint index, const char *name);
Geoff Langd8605522016-04-13 10:19:12 -0400381 void bindUniformLocation(GLuint index, const char *name);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000382
Sami Väisänen46eaa942016-06-29 10:26:37 +0300383 // CHROMIUM_path_rendering
Jamie Madillbd044ed2017-06-05 12:59:21 -0400384 BindingInfo getFragmentInputBindingInfo(const Context *context, GLint index) const;
Sami Väisänen46eaa942016-06-29 10:26:37 +0300385 void bindFragmentInputLocation(GLint index, const char *name);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400386 void pathFragmentInputGen(const Context *context,
387 GLint index,
Sami Väisänen46eaa942016-06-29 10:26:37 +0300388 GLenum genMode,
389 GLint components,
390 const GLfloat *coeffs);
391
Jamie Madill8ecf7f92017-01-13 17:29:52 -0500392 Error link(const gl::Context *context);
Geoff Lange1a27752015-10-05 13:16:04 -0400393 bool isLinked() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500394
Jamie Madilla2c74982016-12-12 11:20:42 -0500395 Error loadBinary(const Context *context,
396 GLenum binaryFormat,
397 const void *binary,
398 GLsizei length);
399 Error saveBinary(const Context *context,
400 GLenum *binaryFormat,
401 void *binary,
402 GLsizei bufSize,
403 GLsizei *length) const;
Jamie Madillffe00c02017-06-27 16:26:55 -0400404 GLint getBinaryLength(const Context *context) const;
Geoff Langc5629752015-12-07 16:29:04 -0500405 void setBinaryRetrievableHint(bool retrievable);
406 bool getBinaryRetrievableHint() const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000407
Yunchao He61afff12017-03-14 15:34:03 +0800408 void setSeparable(bool separable);
409 bool isSeparable() const;
410
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000411 int getInfoLogLength() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400412 void getInfoLog(GLsizei bufSize, GLsizei *length, char *infoLog) const;
413 void getAttachedShaders(GLsizei maxCount, GLsizei *count, GLuint *shaders) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000414
Geoff Lange1a27752015-10-05 13:16:04 -0400415 GLuint getAttributeLocation(const std::string &name) const;
Jamie Madill63805b42015-08-25 13:17:39 -0400416 bool isAttribLocationActive(size_t attribLocation) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500417
jchen10fd7c3b52017-03-21 15:36:03 +0800418 void getActiveAttribute(GLuint index,
419 GLsizei bufsize,
420 GLsizei *length,
421 GLint *size,
422 GLenum *type,
423 GLchar *name) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400424 GLint getActiveAttributeCount() const;
425 GLint getActiveAttributeMaxLength() const;
Jamie Madill48ef11b2016-04-27 15:21:52 -0400426 const std::vector<sh::Attribute> &getAttributes() const { return mState.mAttributes; }
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000427
Geoff Lang7dd2e102014-11-10 15:19:26 -0500428 GLint getFragDataLocation(const std::string &name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800429 size_t getOutputResourceCount() const;
Geoff Lange0cff192017-05-30 13:04:56 -0400430 const std::vector<GLenum> &getOutputVariableTypes() const
431 {
432 return mState.mOutputVariableTypes;
433 }
Corentin Wallezdb9e5d32017-06-12 12:05:45 -0700434 DrawBufferMask getActiveOutputVariables() const { return mState.mActiveOutputVariables; }
Geoff Lang7dd2e102014-11-10 15:19:26 -0500435
Geoff Lange1a27752015-10-05 13:16:04 -0400436 void getActiveUniform(GLuint index,
437 GLsizei bufsize,
438 GLsizei *length,
439 GLint *size,
440 GLenum *type,
441 GLchar *name) const;
442 GLint getActiveUniformCount() const;
443 GLint getActiveUniformMaxLength() const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500444 GLint getActiveUniformi(GLuint index, GLenum pname) const;
445 bool isValidUniformLocation(GLint location) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400446 const LinkedUniform &getUniformByLocation(GLint location) const;
Jamie Madillac4e9c32017-01-13 14:07:12 -0500447 const VariableLocation &getUniformLocation(GLint location) const;
448 const std::vector<VariableLocation> &getUniformLocations() const;
449 const LinkedUniform &getUniformByIndex(GLuint index) const;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000450
Jamie Madill81c2e252017-09-09 23:32:46 -0400451 enum SetUniformResult
452 {
453 SamplerChanged,
454 NoSamplerChange,
455 };
456
Jamie Madill62d31cb2015-09-11 13:25:51 -0400457 GLint getUniformLocation(const std::string &name) const;
458 GLuint getUniformIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500459 void setUniform1fv(GLint location, GLsizei count, const GLfloat *v);
460 void setUniform2fv(GLint location, GLsizei count, const GLfloat *v);
461 void setUniform3fv(GLint location, GLsizei count, const GLfloat *v);
462 void setUniform4fv(GLint location, GLsizei count, const GLfloat *v);
Jamie Madill81c2e252017-09-09 23:32:46 -0400463 SetUniformResult setUniform1iv(GLint location, GLsizei count, const GLint *v);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500464 void setUniform2iv(GLint location, GLsizei count, const GLint *v);
465 void setUniform3iv(GLint location, GLsizei count, const GLint *v);
466 void setUniform4iv(GLint location, GLsizei count, const GLint *v);
467 void setUniform1uiv(GLint location, GLsizei count, const GLuint *v);
468 void setUniform2uiv(GLint location, GLsizei count, const GLuint *v);
469 void setUniform3uiv(GLint location, GLsizei count, const GLuint *v);
470 void setUniform4uiv(GLint location, GLsizei count, const GLuint *v);
471 void setUniformMatrix2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
472 void setUniformMatrix3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
473 void setUniformMatrix4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
474 void setUniformMatrix2x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
475 void setUniformMatrix3x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
476 void setUniformMatrix2x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
477 void setUniformMatrix4x2fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
478 void setUniformMatrix3x4fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
479 void setUniformMatrix4x3fv(GLint location, GLsizei count, GLboolean transpose, const GLfloat *value);
480
Jamie Madill54164b02017-08-28 15:17:37 -0400481 void getUniformfv(const Context *context, GLint location, GLfloat *params) const;
482 void getUniformiv(const Context *context, GLint location, GLint *params) const;
483 void getUniformuiv(const Context *context, GLint location, GLuint *params) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500484
Geoff Lang7dd2e102014-11-10 15:19:26 -0500485 void getActiveUniformBlockName(GLuint uniformBlockIndex, GLsizei bufSize, GLsizei *length, GLchar *uniformBlockName) const;
Geoff Lange1a27752015-10-05 13:16:04 -0400486 GLuint getActiveUniformBlockCount() const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800487 GLuint getActiveShaderStorageBlockCount() const;
Geoff Lange1a27752015-10-05 13:16:04 -0400488 GLint getActiveUniformBlockMaxLength() const;
shannonwoods@chromium.orge684b582013-05-30 00:07:42 +0000489
Geoff Lange1a27752015-10-05 13:16:04 -0400490 GLuint getUniformBlockIndex(const std::string &name) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500491
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000492 void bindUniformBlock(GLuint uniformBlockIndex, GLuint uniformBlockBinding);
493 GLuint getUniformBlockBinding(GLuint uniformBlockIndex) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800494 GLuint getShaderStorageBlockBinding(GLuint shaderStorageBlockIndex) const;
shannonwoods@chromium.org70eb1ea2013-05-30 00:07:20 +0000495
Jiajia Qin729b2c62017-08-14 09:36:11 +0800496 const InterfaceBlock &getUniformBlockByIndex(GLuint index) const;
Gregoire Payen de La Garanderie68694e92015-03-24 14:03:37 +0000497
Geoff Lang48dcae72014-02-05 16:28:24 -0500498 void setTransformFeedbackVaryings(GLsizei count, const GLchar *const *varyings, GLenum bufferMode);
499 void getTransformFeedbackVarying(GLuint index, GLsizei bufSize, GLsizei *length, GLsizei *size, GLenum *type, GLchar *name) const;
Geoff Lang1b6edcb2014-02-03 14:27:56 -0500500 GLsizei getTransformFeedbackVaryingCount() const;
501 GLsizei getTransformFeedbackVaryingMaxLength() const;
502 GLenum getTransformFeedbackBufferMode() const;
503
Frank Henigmanfccbac22017-05-28 17:29:26 -0400504 static bool linkValidateInterfaceBlockFields(InfoLog &infoLog,
505 const std::string &uniformName,
506 const sh::InterfaceBlockField &vertexUniform,
507 const sh::InterfaceBlockField &fragmentUniform,
508 bool webglCompatibility);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500509
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000510 void addRef();
Jamie Madill6c1f6712017-02-14 19:08:04 -0500511 void release(const Context *context);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000512 unsigned int getRefCount() const;
513 void flagForDeletion();
514 bool isFlaggedForDeletion() const;
515
Brandon Jones43a53e22014-08-28 16:23:22 -0700516 void validate(const Caps &caps);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500517 bool validateSamplers(InfoLog *infoLog, const Caps &caps);
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000518 bool isValidated() const;
Jamie Madilla4595b82017-01-11 17:36:34 -0500519 bool samplesFromTexture(const gl::State &state, GLuint textureID) const;
apatrick@chromium.org90080e32012-07-09 22:15:33 +0000520
Jamie Madill63805b42015-08-25 13:17:39 -0400521 const AttributesMask &getActiveAttribLocationsMask() const
522 {
Jamie Madill48ef11b2016-04-27 15:21:52 -0400523 return mState.mActiveAttribLocationsMask;
Jamie Madill63805b42015-08-25 13:17:39 -0400524 }
525
Jamie Madille7d84322017-01-10 18:21:59 -0500526 const std::vector<SamplerBinding> &getSamplerBindings() const
527 {
528 return mState.mSamplerBindings;
529 }
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800530
531 const std::vector<ImageBinding> &getImageBindings() const { return mState.mImageBindings; }
532
Jamie Madilldf68a6f2017-01-13 17:29:53 -0500533 const ProgramState &getState() const { return mState; }
Jamie Madille7d84322017-01-10 18:21:59 -0500534
Olli Etuahob78707c2017-03-09 15:03:11 +0000535 static bool linkValidateVariablesBase(InfoLog &infoLog,
536 const std::string &variableName,
537 const sh::ShaderVariable &vertexVariable,
538 const sh::ShaderVariable &fragmentVariable,
539 bool validatePrecision);
540
jchen1015015f72017-03-16 13:54:21 +0800541 GLuint getInputResourceIndex(const GLchar *name) const;
542 GLuint getOutputResourceIndex(const GLchar *name) const;
jchen10fd7c3b52017-03-21 15:36:03 +0800543 void getInputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
544 void getOutputResourceName(GLuint index, GLsizei bufSize, GLsizei *length, GLchar *name) const;
jchen10880683b2017-04-12 16:21:55 +0800545 const sh::Attribute &getInputResource(GLuint index) const;
546 const sh::OutputVariable &getOutputResource(GLuint index) const;
jchen1015015f72017-03-16 13:54:21 +0800547
Geoff Langd8605522016-04-13 10:19:12 -0400548 class Bindings final : angle::NonCopyable
549 {
550 public:
551 void bindLocation(GLuint index, const std::string &name);
552 int getBinding(const std::string &name) const;
553
554 typedef std::unordered_map<std::string, GLuint>::const_iterator const_iterator;
555 const_iterator begin() const;
556 const_iterator end() const;
557
558 private:
559 std::unordered_map<std::string, GLuint> mBindings;
560 };
561
Jamie Madill32447362017-06-28 14:53:52 -0400562 const Bindings &getAttributeBindings() const { return mAttributeBindings; }
563 const Bindings &getUniformLocationBindings() const { return mUniformLocationBindings; }
564 const Bindings &getFragmentInputBindings() const { return mFragmentInputBindings; }
565
Martin Radev4e619f52017-08-09 11:50:06 +0300566 int getNumViews() const { return mState.getNumViews(); }
567 bool usesMultiview() const { return mState.usesMultiview(); }
Martin Radev7cf61662017-07-26 17:10:53 +0300568
Olli Etuahob78707c2017-03-09 15:03:11 +0000569 private:
Jamie Madill4928b7c2017-06-20 12:57:39 -0400570 ~Program();
571
Jamie Madill192745a2016-12-22 15:58:21 -0500572 struct VaryingRef
573 {
574 const sh::Varying *get() const { return vertex ? vertex : fragment; }
575
576 const sh::Varying *vertex = nullptr;
577 const sh::Varying *fragment = nullptr;
578 };
579
580 using MergedVaryings = std::map<std::string, VaryingRef>;
581
Jamie Madill6c1f6712017-02-14 19:08:04 -0500582 void unlink();
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000583
Jamie Madillbd044ed2017-06-05 12:59:21 -0400584 bool linkAttributes(const Context *context, InfoLog &infoLog);
Martin Radev4c4c8e72016-08-04 12:25:34 +0300585 bool validateVertexAndFragmentInterfaceBlocks(
586 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
587 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400588 InfoLog &infoLog,
589 bool webglCompatibility) const;
Jiajia Qin729b2c62017-08-14 09:36:11 +0800590 bool linkInterfaceBlocks(const Context *context, InfoLog &infoLog);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400591 bool linkVaryings(const Context *context, InfoLog &infoLog) const;
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000592
Jamie Madillbd044ed2017-06-05 12:59:21 -0400593 bool linkUniforms(const Context *context,
594 InfoLog &infoLog,
595 const Bindings &uniformLocationBindings);
Xinghua Cao65ec0b22017-03-28 16:10:52 +0800596 void linkSamplerAndImageBindings();
jchen10eaef1e52017-06-13 10:44:11 +0800597 bool linkAtomicCounterBuffers();
Olli Etuaho6ca2b652017-02-19 18:05:10 +0000598
Jamie Madilla2c74982016-12-12 11:20:42 -0500599 bool areMatchingInterfaceBlocks(InfoLog &infoLog,
Martin Radev4c4c8e72016-08-04 12:25:34 +0300600 const sh::InterfaceBlock &vertexInterfaceBlock,
Frank Henigmanfccbac22017-05-28 17:29:26 -0400601 const sh::InterfaceBlock &fragmentInterfaceBlock,
602 bool webglCompatibility) const;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500603
Yuly Novikova1f6dc92016-06-15 23:27:04 -0400604 static bool linkValidateVaryings(InfoLog &infoLog,
605 const std::string &varyingName,
606 const sh::Varying &vertexVarying,
607 const sh::Varying &fragmentVarying,
608 int shaderVersion);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400609 bool linkValidateBuiltInVaryings(const Context *context, InfoLog &infoLog) const;
jchen10a9042d32017-03-17 08:50:45 +0800610 bool linkValidateTransformFeedback(const gl::Context *context,
611 InfoLog &infoLog,
Jamie Madill192745a2016-12-22 15:58:21 -0500612 const MergedVaryings &linkedVaryings,
Jamie Madillccdf74b2015-08-18 10:46:12 -0400613 const Caps &caps) const;
Yuly Novikovcaa5cda2017-06-15 21:14:03 -0400614 bool linkValidateGlobalNames(const Context *context, InfoLog &infoLog) const;
Jamie Madillccdf74b2015-08-18 10:46:12 -0400615
Jamie Madill192745a2016-12-22 15:58:21 -0500616 void gatherTransformFeedbackVaryings(const MergedVaryings &varyings);
Geoff Lang7dd2e102014-11-10 15:19:26 -0500617
Jamie Madillbd044ed2017-06-05 12:59:21 -0400618 MergedVaryings getMergedVaryings(const Context *context) const;
Jamie Madill192745a2016-12-22 15:58:21 -0500619 std::vector<PackedVarying> getPackedVaryings(const MergedVaryings &mergedVaryings) const;
Jamie Madillbd044ed2017-06-05 12:59:21 -0400620 void linkOutputVariables(const Context *context);
Jamie Madillccdf74b2015-08-18 10:46:12 -0400621
Olli Etuaho48fed632017-03-16 12:05:30 +0000622 void setUniformValuesFromBindingQualifiers();
623
jchen10eaef1e52017-06-13 10:44:11 +0800624 void gatherAtomicCounterBuffers();
Jiajia Qin729b2c62017-08-14 09:36:11 +0800625 void gatherComputeBlockInfo(const std::vector<sh::InterfaceBlock> &computeBlocks);
626 void gatherVertexAndFragmentBlockInfo(
627 const std::vector<sh::InterfaceBlock> &vertexInterfaceBlocks,
628 const std::vector<sh::InterfaceBlock> &fragmentInterfaceBlocks);
Jamie Madillbd044ed2017-06-05 12:59:21 -0400629 void gatherInterfaceBlockInfo(const Context *context);
Jamie Madill4a3c2342015-10-08 12:58:45 -0400630 template <typename VarT>
631 void defineUniformBlockMembers(const std::vector<VarT> &fields,
632 const std::string &prefix,
Olli Etuaho855d9642017-05-17 14:05:06 +0300633 const std::string &mappedPrefix,
Jamie Madill4a3c2342015-10-08 12:58:45 -0400634 int blockIndex);
635
Jiajia Qin729b2c62017-08-14 09:36:11 +0800636 void defineInterfaceBlock(const sh::InterfaceBlock &interfaceBlock, GLenum shaderType);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400637
Corentin Wallez8b7d8142016-11-15 13:40:37 -0500638 // Both these function update the cached uniform values and return a modified "count"
639 // so that the uniform update doesn't overflow the uniform.
Jamie Madill62d31cb2015-09-11 13:25:51 -0400640 template <typename T>
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400641 GLsizei clampUniformCount(const VariableLocation &locationInfo,
642 GLsizei count,
643 int vectorSize,
Jamie Madille7d84322017-01-10 18:21:59 -0500644 const T *v);
Jamie Madillbe5e2ec2017-08-31 13:28:28 -0400645 template <size_t cols, size_t rows, typename T>
646 GLsizei clampMatrixUniformCount(GLint location, GLsizei count, GLboolean transpose, const T *v);
647
648 void updateSamplerUniform(const VariableLocation &locationInfo,
649 GLsizei clampedCount,
650 const GLint *v);
Jamie Madill62d31cb2015-09-11 13:25:51 -0400651
652 template <typename DestT>
Jamie Madill54164b02017-08-28 15:17:37 -0400653 void getUniformInternal(const Context *context,
654 DestT *dataOut,
655 GLint location,
656 GLenum nativeType,
657 int components) const;
Jamie Madill62d31cb2015-09-11 13:25:51 -0400658
Jamie Madill48ef11b2016-04-27 15:21:52 -0400659 ProgramState mState;
Geoff Lang7dd2e102014-11-10 15:19:26 -0500660 rx::ProgramImpl *mProgram;
661
Geoff Lang7dd2e102014-11-10 15:19:26 -0500662 bool mValidated;
663
Geoff Langd8605522016-04-13 10:19:12 -0400664 Bindings mAttributeBindings;
Olli Etuaho4a92ceb2017-02-19 17:51:24 +0000665
666 // Note that this has nothing to do with binding layout qualifiers that can be set for some
667 // uniforms in GLES3.1+. It is used to pre-set the location of uniforms.
668 Bindings mUniformLocationBindings;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000669
Sami Väisänen46eaa942016-06-29 10:26:37 +0300670 // CHROMIUM_path_rendering
671 Bindings mFragmentInputBindings;
672
daniel@transgaming.com716056c2012-07-24 18:38:59 +0000673 bool mLinked;
apatrick@chromium.orge2a59bb2012-06-07 21:09:53 +0000674 bool mDeleteStatus; // Flag to indicate that the program can be deleted when no longer in use
daniel@transgaming.com4fa08332010-05-11 02:29:27 +0000675
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000676 unsigned int mRefCount;
677
Geoff Lang4ddf5af2016-12-01 14:30:44 -0500678 ShaderProgramManager *mResourceManager;
daniel@transgaming.comda13f3e2010-07-28 19:20:56 +0000679 const GLuint mHandle;
apatrick@chromium.org253b8d22012-06-22 19:27:21 +0000680
681 InfoLog mInfoLog;
Jamie Madill3d3d2f22015-09-23 16:47:51 -0400682
683 // Cache for sampler validation
684 Optional<bool> mCachedValidateSamplersResult;
685 std::vector<GLenum> mTextureUnitTypesCache;
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000686};
Jamie Madilla2c74982016-12-12 11:20:42 -0500687} // namespace gl
daniel@transgaming.com4f39fd92010-03-08 20:26:45 +0000688
Geoff Lang0a73dd82014-11-19 16:18:08 -0500689#endif // LIBANGLE_PROGRAM_H_