2019-11-23 20:27:39 +08:00
|
|
|
/****************************************************************************
|
|
|
|
Copyright (c) 2018-2019 Xiamen Yaji Software Co., Ltd.
|
2022-03-13 12:05:22 +08:00
|
|
|
Copyright (c) 2022 Bytedance Inc.
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2022-10-01 16:24:52 +08:00
|
|
|
https://axmolengine.github.io/
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
|
|
in the Software without restriction, including without limitation the rights
|
|
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
|
|
all copies or substantial portions of the Software.
|
|
|
|
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
THE SOFTWARE.
|
|
|
|
****************************************************************************/
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include "../Macros.h"
|
|
|
|
#include "../CommandBuffer.h"
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "base/EventListenerCustom.h"
|
|
|
|
#include "platform/GL.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
2023-06-11 13:08:08 +08:00
|
|
|
#include "StdC.h"
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
#include <vector>
|
|
|
|
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BACKEND_BEGIN
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
class BufferGL;
|
|
|
|
class RenderPipelineGL;
|
|
|
|
class ProgramGL;
|
|
|
|
class DepthStencilStateGL;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @addtogroup _opengl
|
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Store encoded commands for the GPU to execute.
|
|
|
|
* A command buffer stores encoded commands until the buffer is committed for execution by the GPU
|
|
|
|
*/
|
|
|
|
class CommandBufferGL final : public CommandBuffer
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
CommandBufferGL();
|
|
|
|
~CommandBufferGL();
|
2020-09-22 16:32:17 +08:00
|
|
|
/**
|
|
|
|
* Set depthStencil status once
|
|
|
|
* @param depthStencilState Specifies the depth and stencil status
|
|
|
|
*/
|
|
|
|
virtual void setDepthStencilState(DepthStencilState* depthStencilState) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the current render pipeline state object once
|
2021-12-25 10:04:45 +08:00
|
|
|
* @param renderPipeline An object that contains the graphics functions and configuration state used in a render
|
|
|
|
* pass.
|
2020-09-22 16:32:17 +08:00
|
|
|
*/
|
|
|
|
virtual void setRenderPipeline(RenderPipeline* renderPipeline) override;
|
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/// @name Setters & Getters
|
|
|
|
/**
|
|
|
|
* @brief Indicate the begining of a frame
|
|
|
|
*/
|
2021-04-22 22:01:47 +08:00
|
|
|
virtual bool beginFrame() override;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Begin a render pass, initial color, depth and stencil attachment.
|
|
|
|
* @param descriptor Specifies a group of render targets that hold the results of a render pass.
|
|
|
|
*/
|
2021-04-22 22:01:47 +08:00
|
|
|
virtual void beginRenderPass(const RenderTarget* rt, const RenderPassDescriptor& descriptor) override;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
2020-09-22 16:32:17 +08:00
|
|
|
* Update depthStencil status, improvment: for metal backend cache it
|
|
|
|
* @param depthStencilState Specifies the depth and stencil status
|
2019-11-23 20:27:39 +08:00
|
|
|
*/
|
2020-09-22 16:32:17 +08:00
|
|
|
virtual void updateDepthStencilState(const DepthStencilDescriptor& descriptor) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update render pipeline status
|
|
|
|
* @param depthStencilState Specifies the depth and stencil status
|
|
|
|
*/
|
|
|
|
virtual void updatePipelineState(const RenderTarget* rt, const PipelineDescriptor& descriptor) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Fixed-function state
|
|
|
|
* @param x The x coordinate of the upper-left corner of the viewport.
|
|
|
|
* @param y The y coordinate of the upper-left corner of the viewport.
|
|
|
|
* @param w The width of the viewport, in pixels.
|
|
|
|
* @param h The height of the viewport, in pixels.
|
|
|
|
*/
|
|
|
|
virtual void setViewport(int x, int y, unsigned int w, unsigned int h) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Fixed-function state
|
|
|
|
* @param mode Controls if primitives are culled when front facing, back facing, or not culled at all.
|
|
|
|
*/
|
|
|
|
virtual void setCullMode(CullMode mode) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Fixed-function state
|
|
|
|
* @param winding The winding order of front-facing primitives.
|
|
|
|
*/
|
|
|
|
virtual void setWinding(Winding winding) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set a global buffer for all vertex shaders at the given bind point index 0.
|
|
|
|
* @param buffer The vertex buffer to be setted in the buffer argument table.
|
|
|
|
*/
|
|
|
|
virtual void setVertexBuffer(Buffer* buffer) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set unifroms and textures
|
|
|
|
* @param programState A programState object that hold the uniform and texture data.
|
|
|
|
*/
|
|
|
|
virtual void setProgramState(ProgramState* programState) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set indexes when drawing primitives with index list
|
|
|
|
* @ buffer A buffer object that the device will read indexes from.
|
|
|
|
* @ see `drawElements(PrimitiveType primitiveType, IndexFormat indexType, unsigned int count, unsigned int offset)`
|
|
|
|
*/
|
|
|
|
virtual void setIndexBuffer(Buffer* buffer) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Draw primitives without an index list.
|
|
|
|
* @param primitiveType The type of primitives that elements are assembled into.
|
|
|
|
* @param start For each instance, the first index to draw
|
|
|
|
* @param count For each instance, the number of indexes to draw
|
|
|
|
* @see `drawElements(PrimitiveType primitiveType, IndexFormat indexType, unsigned int count, unsigned int offset)`
|
|
|
|
*/
|
2022-08-06 16:17:55 +08:00
|
|
|
virtual void drawArrays(PrimitiveType primitiveType, std::size_t start, std::size_t count, bool wireframe = false) override;
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Draw primitives with an index list.
|
|
|
|
* @param primitiveType The type of primitives that elements are assembled into.
|
|
|
|
* @param indexType The type if indexes, either 16 bit integer or 32 bit integer.
|
|
|
|
* @param count The number of indexes to read from the index buffer for each instance.
|
|
|
|
* @param offset Byte offset within indexBuffer to start reading indexes from.
|
|
|
|
* @see `setIndexBuffer(Buffer* buffer)`
|
|
|
|
* @see `drawArrays(PrimitiveType primitiveType, unsigned int start, unsigned int count)`
|
2021-12-25 10:04:45 +08:00
|
|
|
*/
|
|
|
|
virtual void drawElements(PrimitiveType primitiveType,
|
|
|
|
IndexFormat indexType,
|
|
|
|
std::size_t count,
|
2022-08-06 16:17:55 +08:00
|
|
|
std::size_t offset,
|
|
|
|
bool wireframe = false) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Do some resources release.
|
|
|
|
*/
|
|
|
|
virtual void endRenderPass() override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Present a drawable and commit a command buffer so it can be executed as soon as possible.
|
|
|
|
*/
|
|
|
|
virtual void endFrame() override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Fixed-function state
|
|
|
|
* @param lineWidth Specifies the width of rasterized lines.
|
|
|
|
*/
|
|
|
|
virtual void setLineWidth(float lineWidth) override;
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
/**
|
|
|
|
* Fixed-function state
|
|
|
|
* @param x, y Specifies the lower left corner of the scissor box
|
|
|
|
* @param wdith Specifies the width of the scissor box
|
|
|
|
* @param height Specifies the height of the scissor box
|
|
|
|
*/
|
|
|
|
virtual void setScissorRect(bool isEnabled, float x, float y, float width, float height) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a screen snapshot
|
|
|
|
* @param callback A callback to deal with screen snapshot image.
|
|
|
|
*/
|
2020-09-21 22:10:50 +08:00
|
|
|
virtual void readPixels(RenderTarget* rt, std::function<void(const PixelBufferDescriptor&)> callback) override;
|
|
|
|
|
|
|
|
protected:
|
2021-12-25 10:04:45 +08:00
|
|
|
void readPixels(RenderTarget* rt,
|
|
|
|
int x,
|
|
|
|
int y,
|
|
|
|
uint32_t width,
|
|
|
|
uint32_t height,
|
|
|
|
uint32_t bytesPerRow,
|
|
|
|
PixelBufferDescriptor& pbd);
|
2019-11-23 20:27:39 +08:00
|
|
|
|
|
|
|
private:
|
2021-12-25 10:04:45 +08:00
|
|
|
|
2019-11-23 20:27:39 +08:00
|
|
|
void prepareDrawing() const;
|
|
|
|
void bindVertexBuffer(ProgramGL* program) const;
|
2023-07-19 19:18:17 +08:00
|
|
|
void bindUniforms(ProgramGL* program) const;
|
2019-11-23 20:27:39 +08:00
|
|
|
void cleanResources();
|
|
|
|
|
2021-12-25 10:04:45 +08:00
|
|
|
BufferGL* _vertexBuffer = nullptr;
|
|
|
|
ProgramState* _programState = nullptr;
|
|
|
|
BufferGL* _indexBuffer = nullptr;
|
|
|
|
RenderPipelineGL* _renderPipeline = nullptr;
|
|
|
|
CullMode _cullMode = CullMode::NONE;
|
2019-11-23 20:27:39 +08:00
|
|
|
DepthStencilStateGL* _depthStencilStateGL = nullptr;
|
|
|
|
Viewport _viewPort;
|
|
|
|
GLboolean _alphaTestEnabled = false;
|
|
|
|
|
2022-07-16 10:43:05 +08:00
|
|
|
#if AX_ENABLE_CACHE_TEXTURE_DATA
|
2019-11-23 20:27:39 +08:00
|
|
|
EventListenerCustom* _backToForegroundListener = nullptr;
|
|
|
|
#endif
|
|
|
|
};
|
|
|
|
|
|
|
|
// end of _opengl group
|
|
|
|
/// @}
|
2022-07-11 17:50:21 +08:00
|
|
|
NS_AX_BACKEND_END
|