1 #ifndef DALI_GRAPHICS_GLES_PROGRAM_H
2 #define DALI_GRAPHICS_GLES_PROGRAM_H
5 * Copyright (c) 2023 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
21 #include <dali/graphics-api/graphics-program-create-info.h>
22 #include <dali/graphics-api/graphics-program.h>
25 #include "gles-graphics-resource.h"
27 namespace Dali::Graphics::GLES
32 * @brief Program implementation
34 * Program implementation is owned only by the PipelineCache
36 * Like pipeline, it's created and managed by the PipelineCache
44 * @param[in] createInfo Valid create info structure
45 * @param[in] controller Valid reference to the controller object
47 ProgramImpl(const Graphics::ProgramCreateInfo& createInfo, Graphics::EglGraphicsController& controller);
55 * @brief Destroys GL resources associated with the Program
57 * @return True on success
62 * @brief Creates GL resource for this Program
64 * @return True on success
69 * @brief Returns GL program id
71 * @return GL program id
73 [[nodiscard]] uint32_t GetGlProgram() const;
76 * @brief Increases ref count
78 * @return new refcount
83 * @brief Decreases ref count
85 * @return New refcount
90 * @brief Retrieves ref count
91 * @return Refcount value
93 [[nodiscard]] uint32_t GetRefCount() const;
96 * @brief Returns reflection
98 * @return Valid reflection associated with the Program
100 [[nodiscard]] const GLES::Reflection& GetReflection() const;
103 * @brief Returns controller
105 * @return Valid Controller object
107 [[nodiscard]] EglGraphicsController& GetController() const;
110 * @brief Returns create info structure
112 * @return Reference to valid create info structure
114 [[nodiscard]] const ProgramCreateInfo& GetCreateInfo() const;
117 * @brief Returns parameter value specified by parameterId
119 * This function can be used as a backdoor into the implementation
120 * used to retrieve internal data.
122 * @param[in] parameterId Integer parameter id
123 * @param[out] out Pointer to write to
125 * @return True on success
127 bool GetParameter(uint32_t parameterId, void* out);
130 * @brief Updates standalone uniforms
132 * Updates standalone uniforms (issues the GL calls) and
133 * updates internal uniform cache
135 * @param[in] ptr Valid pointer to the uniform block memory
137 void UpdateStandaloneUniformBlock(const char* ptr);
140 * @brief Builds standalone uniform cache
142 * This function allocates cache memory and
143 * gathers a list of GL functions per uniform type.
145 void BuildStandaloneUniformCache();
148 friend class Program;
151 std::unique_ptr<Impl> mImpl;
154 ///////////////////////////////////////////////////////////////
157 * @brief Wrapper for the program implementation
159 * This object is returned back to the client-side
161 class Program : public Graphics::Program
167 * @param[in] impl Pointer to valid implementation
169 explicit Program(ProgramImpl* impl)
181 * @brief Returns reference to the Reflection object
185 [[nodiscard]] const GLES::Reflection& GetReflection() const;
188 * @brief Retrieves internal program implementation
190 * @return Valid pointer to the ProgramImpl object
192 [[nodiscard]] ProgramImpl* GetImplementation() const
198 * @brief Returns controller
202 [[nodiscard]] EglGraphicsController& GetController() const;
205 * @brief Returns create info structure
207 * @return create info structure
209 [[nodiscard]] const ProgramCreateInfo& GetCreateInfo() const;
211 bool operator==(const GLES::Program& program) const
213 return (program.mProgram == mProgram);
216 bool operator==(const GLES::ProgramImpl* programImpl) const
218 return (programImpl == mProgram);
221 bool operator!=(const GLES::Program& program) const
223 return (program.mProgram != mProgram);
227 * @brief Run by UniquePtr to discard resource
229 void DiscardResource();
232 * @brief Destroying GL resources
234 * This function is kept for compatibility with Resource<> class
235 * so can the object can be use with templated functions.
237 void DestroyResource()
239 // nothing to do here
243 ProgramImpl* mProgram{nullptr};
245 } // namespace Dali::Graphics::GLES
247 #endif //DALI_GRAPHICS_GLES_PROGRAM_H