Google Git
Sign in
skia/external/github.com/rive-app/rive-cpp/e1a36217203f94e75e43af3ee9f4ea7783e6377d/./renderer/src/gl/render_context_gl_impl.cpp
blob: 7f0a8b3dc2d1643f917b09ee20b648396f6d23b9 [file]
/*
* Copyright 2022 Rive
*/
#include "rive/renderer/gl/render_context_gl_impl.hpp"
#include "rive/decoders/astc_footprints.hpp"
#include "rive/renderer/gl/render_buffer_gl_impl.hpp"
#include "rive/renderer/gl/render_target_gl.hpp"
#include "rive/renderer/draw.hpp"
#ifdef RIVE_CANVAS
#include "rive/renderer/render_canvas.hpp"
#include "rive/renderer/ore/ore_context_gl.hpp"
#endif
#include "rive/renderer/render_context_impl.hpp"
#include "rive/renderer/rive_renderer.hpp"
#include "rive/renderer/texture.hpp"
#include "shaders/constants.glsl"
#include "instance_chunker.hpp"
#include "generated/shaders/advanced_blend.glsl.hpp"
#include "generated/shaders/color_ramp.glsl.hpp"
#include "generated/shaders/constants.glsl.hpp"
#include "generated/shaders/image_draw_uniforms.glsl.hpp"
#include "generated/shaders/flush_uniforms.glsl.hpp"
#include "generated/shaders/common.glsl.hpp"
#include "generated/shaders/draw_path_common.glsl.hpp"
#include "generated/shaders/draw_path.vert.hpp"
#include "generated/shaders/draw_raster_order_path.frag.hpp"
#include "generated/shaders/draw_clockwise_path.frag.hpp"
#include "generated/shaders/draw_clockwise_clip.frag.hpp"
#include "generated/shaders/draw_image_mesh.vert.hpp"
#include "generated/shaders/draw_mesh.frag.hpp"
#include "generated/shaders/draw_msaa_object.frag.hpp"
#include "generated/shaders/bezier_utils.glsl.hpp"
#include "generated/shaders/tessellate.glsl.hpp"
#include "generated/shaders/render_atlas.glsl.hpp"
#include "generated/shaders/resolve_atlas.glsl.hpp"
#include "generated/shaders/blit_texture_as_draw.glsl.hpp"
#include "generated/shaders/stencil_draw.glsl.hpp"
#ifdef RIVE_WEBGL
#include <emscripten/emscripten.h>
#include <emscripten/html5.h>
// In an effort to save space on web, and since web doesn't have ES 3.1 level
// support, don't include the atomic sources.
namespace rive::gpu::glsl
{
const char atomic_draw[] = "";
}
#define DISABLE_PLS_ATOMICS
#else
#include "generated/shaders/atomic_draw.glsl.hpp"
#endif
namespace rive::gpu
{
static bool is_tessellation_draw(gpu::DrawType drawType)
{
switch (drawType)
{
case gpu::DrawType::midpointFanPatches:
case gpu::DrawType::midpointFanCenterAAPatches:
case gpu::DrawType::outerCurvePatches:
case gpu::DrawType::msaaStrokes:
case gpu::DrawType::msaaMidpointFanBorrowedCoverage:
case gpu::DrawType::msaaMidpointFans:
case gpu::DrawType::msaaMidpointFanStencilReset:
case gpu::DrawType::msaaMidpointFanPathsStencil:
case gpu::DrawType::msaaMidpointFanPathsCover:
case gpu::DrawType::msaaOuterCubics:
return true;
case gpu::DrawType::imageRect:
case gpu::DrawType::imageMesh:
case gpu::DrawType::interiorTriangulation:
case gpu::DrawType::atlasBlit:
case gpu::DrawType::clipReset:
case gpu::DrawType::renderPassInitialize:
case gpu::DrawType::renderPassResolve:
return false;
}
RIVE_UNREACHABLE();
}
// Returns atlasDesiredRenderType, or the next supported AtlasRenderType down
// the list if it is not supported.
static RenderContextGLImpl::AtlasRenderType select_atlas_render_type(
const GLCapabilities& capabilities,
RenderContextGLImpl::AtlasRenderType atlasDesiredRenderType =
RenderContextGLImpl::AtlasRenderType::r16f)
{
switch (atlasDesiredRenderType)
{
using AtlasRenderType = RenderContextGLImpl::AtlasRenderType;
case AtlasRenderType::r16f:
if (capabilities.EXT_color_buffer_half_float)
{
return AtlasRenderType::r16f;
}
[[fallthrough]];
case AtlasRenderType::r32f:
if (capabilities.EXT_color_buffer_float &&
capabilities.EXT_float_blend)
{
// fp32 is ideal for the atlas. When there's a lot of overlap,
// fp16 can run out of precision.
return AtlasRenderType::r32f;
}
[[fallthrough]];
case AtlasRenderType::r32uiFramebufferFetch:
if (capabilities.EXT_shader_framebuffer_fetch)
{
return AtlasRenderType::r32uiFramebufferFetch;
}
[[fallthrough]];
case AtlasRenderType::r8PixelLocalStorageEXT:
#ifdef RIVE_ANDROID
if (capabilities.EXT_shader_pixel_local_storage)
{
return AtlasRenderType::r8PixelLocalStorageEXT;
}
#endif
[[fallthrough]];
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
#ifndef RIVE_ANDROID
if (capabilities.ANGLE_shader_pixel_local_storage_coherent)
{
return AtlasRenderType::r32uiPixelLocalStorageANGLE;
}
#endif
[[fallthrough]];
case AtlasRenderType::r32iAtomicTexture:
#ifndef RIVE_WEBGL
if (capabilities.ARB_shader_image_load_store ||
capabilities.OES_shader_image_atomic)
{
return AtlasRenderType::r32iAtomicTexture;
}
#endif
[[fallthrough]];
case AtlasRenderType::rgba8:
return AtlasRenderType::rgba8;
}
RIVE_UNREACHABLE();
}
RenderContextGLImpl::RenderContextGLImpl(
const char* rendererString,
GLCapabilities capabilities,
std::unique_ptr<PixelLocalStorageImpl> plsImpl,
ShaderCompilationMode shaderCompilationMode) :
m_capabilities(capabilities),
m_plsImpl(std::move(plsImpl)),
m_atlasRenderType(select_atlas_render_type(m_capabilities)),
m_pipelineManager(shaderCompilationMode, this),
m_state(make_rcp<GLState>(m_capabilities))
{
if (m_capabilities.isANGLESystemDriver &&
capabilities.KHR_blend_equation_advanced)
{
// Some ANGLE devices report support for this extension but render
// incorrectly with it, so we'll need to run a quick test to validate
// that we get the proper color out of doing advance blending before
// rendering with it.
m_testForAdvancedBlendError = true;
}
if (m_plsImpl != nullptr)
{
m_plsImpl->getSupportedInterlockModes(m_capabilities,
&m_platformFeatures);
}
if (m_capabilities.KHR_blend_equation_advanced ||
m_capabilities.KHR_blend_equation_advanced_coherent)
{
m_platformFeatures.supportsBlendAdvancedKHR = true;
}
if (m_capabilities.KHR_blend_equation_advanced_coherent)
{
m_platformFeatures.supportsBlendAdvancedCoherentKHR = true;
}
if (m_capabilities.EXT_clip_cull_distance)
{
m_platformFeatures.supportsClipPlanes = true;
}
if (strstr(rendererString, "Apple") && strstr(rendererString, "Metal"))
{
// In Metal, non-flat varyings preserve their exact value if all
// vertices in the triangle emit the same value, and we also see a small
// (5-10%) improvement from not using flat varyings.
m_platformFeatures.avoidFlatVaryings = true;
}
if (m_capabilities.isPowerVR || strstr(rendererString, "Mali-G52"))
{
// PowerVR (Vivo Y21, Rogue GE8320; OpenGL ES 3.2 build 1.13@5776728a)
// and Mali-G52 (Panfrost, e.g. MediaTek MT8169) hit a reset condition
// that corrupts pixel local storage when rendering a complex feather
// directly into PLS. Route feathers through the offscreen atlas on
// these GPUs.
m_platformFeatures.alwaysFeatherToAtlas = true;
}
m_platformFeatures.clipSpaceBottomUp = true;
m_platformFeatures.framebufferBottomUp = true;
GLint maxTextureSize;
glGetIntegerv(GL_MAX_TEXTURE_SIZE, &maxTextureSize);
m_platformFeatures.maxTextureSize = maxTextureSize;
m_platformFeatures.supportsTextureCompressionBC =
m_capabilities.EXT_texture_compression_s3tc &&
m_capabilities.EXT_texture_compression_bptc;
m_platformFeatures.supportsTextureCompressionASTC =
m_capabilities.KHR_texture_compression_astc_ldr;
m_platformFeatures.supportsTextureCompressionETC2 =
m_capabilities.supportsETC2;
std::vector<const char*> generalDefines;
if (!m_capabilities.ARB_shader_storage_buffer_object)
{
generalDefines.push_back(GLSL_DISABLE_SHADER_STORAGE_BUFFERS);
}
const char* colorRampSources[] = {glsl::constants,
glsl::flush_uniforms,
glsl::common,
glsl::color_ramp};
m_colorRampProgram.compileAndAttachShader(GL_VERTEX_SHADER,
generalDefines.data(),
generalDefines.size(),
colorRampSources,
std::size(colorRampSources),
m_capabilities);
m_colorRampProgram.compileAndAttachShader(GL_FRAGMENT_SHADER,
generalDefines.data(),
generalDefines.size(),
colorRampSources,
std::size(colorRampSources),
m_capabilities);
m_colorRampProgram.link();
glUniformBlockBinding(
m_colorRampProgram,
glGetUniformBlockIndex(m_colorRampProgram, GLSL_FlushUniforms),
FLUSH_UNIFORM_BUFFER_IDX);
m_state->bindVAO(m_colorRampVAO);
glEnableVertexAttribArray(0);
glVertexAttribDivisor(0, 1);
// Emulate the feather texture1d array as a texture2d since GLES doesn't
// have texture1d.
glActiveTexture(GL_TEXTURE0 + FEATHER_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_featherTexture);
glTexStorage2D(GL_TEXTURE_2D,
1,
GL_R16F,
gpu::GAUSSIAN_TABLE_SIZE,
FEATHER_TEXTURE_1D_ARRAY_LENGTH);
m_state->bindBuffer(GL_PIXEL_UNPACK_BUFFER, 0);
glTexSubImage2D(GL_TEXTURE_2D,
0,
0,
FEATHER_FUNCTION_ARRAY_INDEX,
gpu::GAUSSIAN_TABLE_SIZE,
1,
GL_RED,
GL_HALF_FLOAT,
gpu::g_gaussianIntegralTableF16);
glTexSubImage2D(GL_TEXTURE_2D,
0,
0,
FEATHER_INVERSE_FUNCTION_ARRAY_INDEX,
gpu::GAUSSIAN_TABLE_SIZE,
1,
GL_RED,
GL_HALF_FLOAT,
gpu::g_inverseGaussianIntegralTableF16);
const GLenum featherTextureFilter =
m_capabilities.OES_texture_half_float_linear ? GL_LINEAR : GL_NEAREST;
glutils::SetTexture2DSamplingParams(featherTextureFilter,
featherTextureFilter);
const char* tessellateSources[] = {glsl::constants,
glsl::flush_uniforms,
glsl::common,
glsl::bezier_utils,
glsl::tessellate};
m_tessellateProgram.compileAndAttachShader(GL_VERTEX_SHADER,
generalDefines.data(),
generalDefines.size(),
tessellateSources,
std::size(tessellateSources),
m_capabilities);
m_tessellateProgram.compileAndAttachShader(GL_FRAGMENT_SHADER,
generalDefines.data(),
generalDefines.size(),
tessellateSources,
std::size(tessellateSources),
m_capabilities);
m_tessellateProgram.link();
m_state->bindProgram(m_tessellateProgram);
glutils::Uniform1iByName(m_tessellateProgram,
GLSL_featherTexture,
FEATHER_TEXTURE_IDX);
glUniformBlockBinding(
m_tessellateProgram,
glGetUniformBlockIndex(m_tessellateProgram, GLSL_FlushUniforms),
FLUSH_UNIFORM_BUFFER_IDX);
if (!m_capabilities.ARB_shader_storage_buffer_object)
{
// Our GL driver doesn't support storage buffers. We polyfill these
// buffers as textures.
glutils::Uniform1iByName(m_tessellateProgram,
GLSL_pathBuffer,
PATH_BUFFER_IDX);
glutils::Uniform1iByName(m_tessellateProgram,
GLSL_contourBuffer,
CONTOUR_BUFFER_IDX);
}
m_state->bindVAO(m_tessellateVAO);
for (int i = 0; i < 4; ++i)
{
glEnableVertexAttribArray(i);
// Draw two instances per TessVertexSpan: one normal and one optional
// reflection.
glVertexAttribDivisor(i, 1);
}
m_state->bindBuffer(GL_ELEMENT_ARRAY_BUFFER, m_tessSpanIndexBuffer);
glBufferData(GL_ELEMENT_ARRAY_BUFFER,
sizeof(gpu::kTessSpanIndices),
gpu::kTessSpanIndices,
GL_STATIC_DRAW);
m_state->bindVAO(m_drawVAO);
PatchVertex patchVertices[kPatchVertexBufferCount];
uint16_t patchIndices[kPatchIndexBufferCount];
GeneratePatchBufferData(patchVertices, patchIndices);
m_state->bindBuffer(GL_ARRAY_BUFFER, m_patchVerticesBuffer);
glBufferData(GL_ARRAY_BUFFER,
sizeof(patchVertices),
patchVertices,
GL_STATIC_DRAW);
m_state->bindBuffer(GL_ELEMENT_ARRAY_BUFFER, m_patchIndicesBuffer);
glBufferData(GL_ELEMENT_ARRAY_BUFFER,
sizeof(patchIndices),
patchIndices,
GL_STATIC_DRAW);
glEnableVertexAttribArray(0);
glVertexAttribPointer(0,
4,
GL_FLOAT,
GL_FALSE,
sizeof(PatchVertex),
nullptr);
glEnableVertexAttribArray(1);
glVertexAttribPointer(1,
4,
GL_FLOAT,
GL_FALSE,
sizeof(PatchVertex),
reinterpret_cast<const void*>(sizeof(float) * 4));
m_state->bindVAO(m_trianglesVAO);
glEnableVertexAttribArray(0);
// We draw imageRects when in atomic mode.
m_state->bindVAO(m_imageRectVAO);
m_state->bindBuffer(GL_ARRAY_BUFFER, m_imageRectVertexBuffer);
glBufferData(GL_ARRAY_BUFFER,
sizeof(gpu::kImageRectVertices),
gpu::kImageRectVertices,
GL_STATIC_DRAW);
glEnableVertexAttribArray(0);
glVertexAttribPointer(0,
4,
GL_FLOAT,
GL_FALSE,
sizeof(gpu::ImageRectVertex),
nullptr);
m_state->bindBuffer(GL_ELEMENT_ARRAY_BUFFER, m_imageRectIndexBuffer);
glBufferData(GL_ELEMENT_ARRAY_BUFFER,
sizeof(gpu::kImageRectIndices),
gpu::kImageRectIndices,
GL_STATIC_DRAW);
m_state->bindVAO(m_imageMeshVAO);
glEnableVertexAttribArray(0);
glEnableVertexAttribArray(1);
if (m_plsImpl != nullptr)
{
m_plsImpl->init(m_state);
}
}
RenderContextGLImpl::~RenderContextGLImpl()
{
glDeleteTextures(1, &m_gradientTexture);
glDeleteTextures(1, &m_tessVertexTexture);
// Because glutils wrappers delete GL objects that might affect bindings.
m_state->invalidate();
}
// Indicates that the atlas needs a fullscreen draw at the end, in order to
// resolve it into a GL_R8 texture that can be sampled.
constexpr static bool needs_atlas_resolve_draw(
RenderContextGLImpl::AtlasRenderType atlasRenderType)
{
switch (atlasRenderType)
{
using AtlasRenderType = RenderContextGLImpl::AtlasRenderType;
case AtlasRenderType::r16f:
case AtlasRenderType::r32f:
return false;
case AtlasRenderType::r32uiFramebufferFetch:
case AtlasRenderType::r8PixelLocalStorageEXT:
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
case AtlasRenderType::r32iAtomicTexture:
case AtlasRenderType::rgba8:
return true;
}
RIVE_UNREACHABLE();
}
void RenderContextGLImpl::buildAtlasRenderPipelines()
{
std::vector<const char*> defines;
defines.push_back(GLSL_DRAW_PATH);
defines.push_back(GLSL_ENABLE_FEATHER);
defines.push_back(GLSL_ENABLE_INSTANCE_INDEX);
if (!m_capabilities.ARB_shader_storage_buffer_object)
{
defines.push_back(GLSL_DISABLE_SHADER_STORAGE_BUFFERS);
}
m_atlasFillPipelineState = gpu::ATLAS_FILL_PIPELINE_STATE;
m_atlasStrokePipelineState = gpu::ATLAS_STROKE_PIPELINE_STATE;
switch (m_atlasRenderType)
{
case AtlasRenderType::r16f:
case AtlasRenderType::r32f:
break;
case AtlasRenderType::r32uiFramebufferFetch:
defines.push_back(GLSL_ATLAS_RENDER_TARGET_R32UI_FRAMEBUFFER_FETCH);
m_atlasFillPipelineState.blendEquation = gpu::BlendEquation::none;
m_atlasStrokePipelineState.blendEquation = gpu::BlendEquation::none;
break;
case AtlasRenderType::r8PixelLocalStorageEXT:
#ifdef RIVE_ANDROID
defines.push_back(GLSL_ATLAS_RENDER_TARGET_R8_PLS_EXT);
m_atlasFillPipelineState.blendEquation = gpu::BlendEquation::none;
m_atlasStrokePipelineState.blendEquation = gpu::BlendEquation::none;
#else
RIVE_UNREACHABLE();
#endif
break;
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
#ifndef RIVE_ANDROID
defines.push_back(GLSL_ATLAS_RENDER_TARGET_R32UI_PLS_ANGLE);
m_atlasFillPipelineState.blendEquation = gpu::BlendEquation::none;
m_atlasStrokePipelineState.blendEquation = gpu::BlendEquation::none;
#else
RIVE_UNREACHABLE();
#endif
break;
case AtlasRenderType::r32iAtomicTexture:
#ifndef RIVE_WEBGL
defines.push_back(GLSL_ATLAS_RENDER_TARGET_R32I_ATOMIC_TEXTURE);
m_atlasFillPipelineState.colorWriteEnabled = false;
m_atlasFillPipelineState.blendEquation = gpu::BlendEquation::none;
m_atlasStrokePipelineState.colorWriteEnabled = false;
m_atlasStrokePipelineState.blendEquation = gpu::BlendEquation::none;
#else
RIVE_UNREACHABLE();
#endif
break;
case AtlasRenderType::rgba8:
defines.push_back(GLSL_ATLAS_RENDER_TARGET_RGBA8_UNORM);
break;
}
const char* atlasSources[] = {glsl::constants,
glsl::flush_uniforms,
glsl::common,
glsl::draw_path_common,
glsl::render_atlas};
m_atlasVertexShader.compile(GL_VERTEX_SHADER,
defines.data(),
defines.size(),
atlasSources,
std::size(atlasSources),
m_capabilities);
defines.push_back(GLSL_ATLAS_FEATHERED_FILL);
m_atlasFillProgram.compile(m_atlasVertexShader,
defines.data(),
defines.size(),
atlasSources,
std::size(atlasSources),
m_capabilities,
m_state.get());
defines.pop_back();
defines.push_back(GLSL_ATLAS_FEATHERED_STROKE);
m_atlasStrokeProgram.compile(m_atlasVertexShader,
defines.data(),
defines.size(),
atlasSources,
std::size(atlasSources),
m_capabilities,
m_state.get());
defines.pop_back();
if (needs_atlas_resolve_draw(m_atlasRenderType))
{
// Build the pipelines for clearing and resolving
// EXT_shader_pixel_local_storage.
m_atlasResolveVertexShader.compile(GL_VERTEX_SHADER,
glsl::resolve_atlas,
m_capabilities);
if (m_atlasRenderType == AtlasRenderType::r8PixelLocalStorageEXT)
{
#ifdef RIVE_ANDROID
// EXT_shader_pixel_local_storage doesn't support clearing, so we
// also need to build a program to clear it at the beginning of the
// atlas render pass.
const char* atlasClearDefines[] = {
GLSL_ATLAS_RENDER_TARGET_R8_PLS_EXT,
GLSL_CLEAR_COVERAGE};
const char* atlasClearSources[] = {glsl::resolve_atlas};
m_atlasClearProgram = glutils::Program();
glAttachShader(m_atlasClearProgram, m_atlasResolveVertexShader);
m_atlasClearProgram.compileAndAttachShader(
GL_FRAGMENT_SHADER,
atlasClearDefines,
std::size(atlasClearDefines),
atlasClearSources,
std::size(atlasClearSources),
m_capabilities);
m_atlasClearProgram.link();
#else
RIVE_UNREACHABLE();
#endif
}
const char* atlasResolveSources[] = {glsl::constants,
glsl::flush_uniforms,
glsl::common,
glsl::resolve_atlas};
m_atlasResolveProgram = glutils::Program();
glAttachShader(m_atlasResolveProgram, m_atlasResolveVertexShader);
m_atlasResolveProgram.compileAndAttachShader(
GL_FRAGMENT_SHADER,
defines.data(),
defines.size(),
atlasResolveSources,
std::size(atlasResolveSources),
m_capabilities);
m_atlasResolveProgram.link();
if (m_atlasRenderType == AtlasRenderType::rgba8)
{
// The "rgba8" resolve shader reads the coverageCount data via
// texelFetch().
m_state->bindProgram(m_atlasResolveProgram);
glutils::Uniform1iByName(m_atlasResolveProgram,
GLSL_atlasRenderTexture,
0);
}
}
}
void RenderContextGLImpl::invalidateGLState()
{
glActiveTexture(GL_TEXTURE0 + TESS_VERTEX_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_tessVertexTexture);
glActiveTexture(GL_TEXTURE0 + GRAD_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_gradientTexture);
glActiveTexture(GL_TEXTURE0 + FEATHER_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_featherTexture);
glActiveTexture(GL_TEXTURE0 + ATLAS_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_atlasTexture);
m_state->invalidate();
}
void RenderContextGLImpl::unbindGLInternalResources()
{
m_state->bindVAO(0);
m_state->bindBuffer(GL_ELEMENT_ARRAY_BUFFER, 0);
m_state->bindBuffer(GL_ARRAY_BUFFER, 0);
m_state->bindBuffer(GL_UNIFORM_BUFFER, 0);
glBindFramebuffer(GL_FRAMEBUFFER, 0);
for (int i = 0; i <= DEFAULT_BINDINGS_SET_SIZE; ++i)
{
glActiveTexture(GL_TEXTURE0 + i);
glBindTexture(GL_TEXTURE_2D, 0);
}
}
rcp<RenderBuffer> RenderContextGLImpl::makeRenderBuffer(RenderBufferType type,
RenderBufferFlags flags,
size_t sizeInBytes)
{
return make_rcp<RenderBufferGLImpl>(type, flags, sizeInBytes, m_state);
}
class TextureGLImpl : public Texture
{
public:
TextureGLImpl(uint32_t width,
uint32_t height,
GLuint textureID,
const GLCapabilities& capabilities) :
Texture(width, height), m_texture(glutils::Texture::Adopt(textureID))
{}
virtual ~TextureGLImpl() = default;
operator GLuint() const { return m_texture; }
void* nativeHandle() const override
{
return reinterpret_cast<void*>(
static_cast<uintptr_t>(static_cast<GLuint>(m_texture)));
}
protected:
glutils::Texture m_texture;
};
#ifdef RIVE_CANVAS
// Lifetime hook for the source texture of a Rive 2D RenderCanvas. When
// this texture is destroyed, the canvas mirror registry entry on the
// owning RenderContextGLImpl must be removed so any subsequent
// wrapRiveTexture lookup for the freed GLuint cannot resurrect a stale
// mirror. The texture's GLuint itself is freed by the base class
// destructor (glutils::Texture RAII).
class CanvasSourceTextureGLImpl : public TextureGLImpl
{
public:
CanvasSourceTextureGLImpl(uint32_t width,
uint32_t height,
GLuint textureID,
const GLCapabilities& caps,
RenderContextGLImpl* owner) :
TextureGLImpl(width, height, textureID, caps),
m_owner(owner),
m_glID(textureID)
{}
~CanvasSourceTextureGLImpl() override
{
if (m_owner != nullptr)
{
m_owner->unregisterCanvasTarget(m_glID);
}
}
private:
RenderContextGLImpl* m_owner;
GLuint m_glID;
};
// Lifetime hook for the mirror texture of an imported canvas. When this
// texture is destroyed, we clear the mirror fields on the registry entry
// (if it still exists) and release the cached read/draw FBOs. The entry
// itself is left in place so the source canvas can re-allocate a new
// mirror later via getOrCreateCanvasMirror.
class CanvasMirrorTextureGLImpl : public TextureGLImpl
{
public:
CanvasMirrorTextureGLImpl(uint32_t width,
uint32_t height,
GLuint textureID,
const GLCapabilities& caps,
RenderContextGLImpl* owner,
GLuint sourceTexID) :
TextureGLImpl(width, height, textureID, caps),
m_owner(owner),
m_sourceTexID(sourceTexID)
{}
~CanvasMirrorTextureGLImpl() override; // Defined below the class
// method definitions on
// RenderContextGLImpl so we
// can call its private API.
private:
RenderContextGLImpl* m_owner;
GLuint m_sourceTexID;
};
#endif // RIVE_CANVAS
rcp<Texture> RenderContextGLImpl::makeImageTexture(uint32_t width,
uint32_t height,
uint32_t mipLevelCount,
GPUTextureFormat format,
const uint8_t imageData[],
uint8_t blockWidth,
uint8_t blockHeight,
[[maybe_unused]] bool srgb,
bool generateRemainingMips)
{
// Pick UNORM internal format. Sampler path treats texels as sRGB-
// encoded bytes (matching the GL_RGBA8 PNG upload).
GLenum sizedInternal;
bool isCompressed = false;
uint32_t bytesPerBlock = 16;
switch (format)
{
case GPUTextureFormat::rgba32:
sizedInternal = GL_RGBA8;
assert(blockWidth == 1 && blockHeight == 1);
bytesPerBlock = 4;
break;
case GPUTextureFormat::bc7:
sizedInternal = 0x8E8C; // GL_COMPRESSED_RGBA_BPTC_UNORM
isCompressed = true;
break;
case GPUTextureFormat::etc2:
sizedInternal = 0x9278; // GL_COMPRESSED_RGBA8_ETC2_EAC
isCompressed = true;
break;
case GPUTextureFormat::astc:
{
const int idx = rive::astcFootprintIndex(blockWidth, blockHeight);
if (idx < 0)
{
assert(!"unsupported ASTC block footprint");
return nullptr;
}
// KHR_texture_compression_astc_ldr lays the per-footprint enums
// out contiguously starting at GL_COMPRESSED_RGBA_ASTC_4x4_KHR, in
// the same canonical order as astcFootprintIndex().
sizedInternal =
static_cast<GLenum>(GL_COMPRESSED_RGBA_ASTC_4x4_KHR + idx);
isCompressed = true;
break;
}
default:
assert(!"unsupported format");
return nullptr;
}
assert(!(generateRemainingMips && isCompressed) &&
"glGenerateMipmap is undefined on compressed textures");
GLuint textureID;
glGenTextures(1, &textureID);
glActiveTexture(GL_TEXTURE0 + IMAGE_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, textureID);
glTexStorage2D(GL_TEXTURE_2D,
static_cast<GLsizei>(mipLevelCount),
sizedInternal,
width,
height);
if (imageData != nullptr)
{
// When the caller wants the GPU to auto-fill mips 1..N from mip 0
// (PNG path), only upload level 0 and finish via glGenerateMipmap.
const uint32_t levelsToUpload =
generateRemainingMips ? 1u : mipLevelCount;
size_t srcOffset = 0;
for (uint32_t i = 0; i < levelsToUpload; ++i)
{
const uint32_t logW = std::max<uint32_t>(1u, width >> i);
const uint32_t logH = std::max<uint32_t>(1u, height >> i);
const uint32_t blocksX = (logW + blockWidth - 1) / blockWidth;
const uint32_t blocksY = (logH + blockHeight - 1) / blockHeight;
const size_t levelBytes =
static_cast<size_t>(blocksX) * blocksY * bytesPerBlock;
if (isCompressed)
{
glCompressedTexSubImage2D(GL_TEXTURE_2D,
static_cast<GLint>(i),
0,
0,
logW,
logH,
sizedInternal,
static_cast<GLsizei>(levelBytes),
imageData + srcOffset);
}
else
{
glTexSubImage2D(GL_TEXTURE_2D,
static_cast<GLint>(i),
0,
0,
logW,
logH,
GL_RGBA,
GL_UNSIGNED_BYTE,
imageData + srcOffset);
}
srcOffset += levelBytes;
}
if (generateRemainingMips && mipLevelCount > 1)
{
glGenerateMipmap(GL_TEXTURE_2D);
}
}
return adoptImageTexture(width, height, textureID);
}
rcp<Texture> RenderContextGLImpl::adoptImageTexture(uint32_t width,
uint32_t height,
GLuint textureID)
{
return make_rcp<TextureGLImpl>(width, height, textureID, m_capabilities);
}
#ifdef RIVE_CANVAS
rcp<RenderCanvas> RenderContextGLImpl::makeRenderCanvas(uint32_t width,
uint32_t height)
{
GLuint tex;
glGenTextures(1, &tex);
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, tex);
glTexStorage2D(GL_TEXTURE_2D, 1, GL_RGBA8, width, height);
// Wrap as a CanvasSourceTextureGLImpl so the registry entry is
// unregistered automatically when the source texture is destroyed.
// The texture takes ownership of `tex` (RAII via glutils::Texture).
auto sourceTexture =
rcp<TextureGLImpl>(new CanvasSourceTextureGLImpl(width,
height,
tex,
m_capabilities,
this));
auto renderImage = make_rcp<RiveRenderImage>(std::move(sourceTexture));
// Wrap as TextureRenderTargetGL. It references the same GLuint without
// taking ownership.
auto renderTarget = make_rcp<TextureRenderTargetGL>(width, height);
renderTarget->setTargetTexture(tex);
// GL renders into the canvas with row 0 = visual bottom (framebuffer
// bottom-up convention). Register the source GLuint with the mirror
// registry so wrapRiveTexture (ore_context_gl.cpp) can detect it
// later and allocate a Y-flipped companion when an Ore pipeline
// imports it as a sampled texture. The registration is bookkeeping
// only — no GPU allocation happens until first import.
// See dev/ore_canvas_import_invariant.md.
registerCanvasTarget(tex);
return make_rcp<RenderCanvas>(std::move(renderImage),
std::move(renderTarget));
}
std::unique_ptr<rive::ore::Context> RenderContextGLImpl::makeOreContext()
{
return rive::ore::ContextGL::Make();
}
// ────────────────────────────────────────────────────────────────────────────
// Canvas mirror registry implementation (GL-only "imported canvas" handling)
// ────────────────────────────────────────────────────────────────────────────
rcp<RiveRenderImage> RenderContextGLImpl::getCanvasImportMirror(
gpu::Texture* sourceTex,
uint32_t width,
uint32_t height)
{
if (sourceTex == nullptr)
{
return nullptr;
}
GLuint glID = static_cast<GLuint>(
reinterpret_cast<uintptr_t>(sourceTex->nativeHandle()));
if (glID == 0)
{
return nullptr;
}
return getOrCreateCanvasMirror(glID, width, height);
}
void RenderContextGLImpl::registerCanvasTarget(GLuint sourceTex)
{
// Insert an empty entry. mirrorTex stays 0 / hasMirror stays false
// until the first wrapRiveTexture call for this source.
m_canvasMirrors[sourceTex] = RenderContextGLImpl::CanvasMirrorEntry{};
}
void RenderContextGLImpl::unregisterCanvasTarget(GLuint sourceTex)
{
auto it = m_canvasMirrors.find(sourceTex);
if (it == m_canvasMirrors.end())
{
return;
}
// Free FBOs if a mirror was ever allocated. The mirror texture itself
// is owned by its CanvasMirrorTextureGLImpl wrapper; that wrapper is
// either still alive (in which case its destructor will be a no-op
// when it tries to remove an already-removed entry) or already dead
// (in which case the FBOs have already been cleared and re-clearing
// is harmless).
if (it->second.readFBO != 0)
{
glDeleteFramebuffers(1, &it->second.readFBO);
}
if (it->second.drawFBO != 0)
{
glDeleteFramebuffers(1, &it->second.drawFBO);
}
m_canvasMirrors.erase(it);
}
rcp<RiveRenderImage> RenderContextGLImpl::getOrCreateCanvasMirror(
GLuint sourceTex,
uint32_t width,
uint32_t height)
{
auto it = m_canvasMirrors.find(sourceTex);
if (it == m_canvasMirrors.end())
{
// Not a registered canvas target — caller should fall through
// and use the source texture directly.
return nullptr;
}
RenderContextGLImpl::CanvasMirrorEntry& entry = it->second;
// If a mirror already exists, the caller should be reusing the
// RiveRenderImage they previously got back from us. We don't keep
// a strong ref to the mirror image (only the wrapping texture
// implementation), so re-creating one here would alias a live
// GLuint and double-free on shutdown. Therefore: if hasMirror is
// true, we MUST NOT allocate again. Return null and let the caller
// sample the source directly as a fallback. In practice this code
// path is unreachable — the Lua binding caches its cachedOreView
// after the first :view() call.
if (entry.hasMirror)
{
return nullptr;
}
// Allocate a new companion texture sized to match the source.
GLuint mirrorTex;
glGenTextures(1, &mirrorTex);
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, mirrorTex);
glTexStorage2D(GL_TEXTURE_2D, 1, GL_RGBA8, width, height);
// Allocate persistent read/draw FBOs and attach source/mirror.
glGenFramebuffers(1, &entry.readFBO);
glGenFramebuffers(1, &entry.drawFBO);
glBindFramebuffer(GL_READ_FRAMEBUFFER, entry.readFBO);
glFramebufferTexture2D(GL_READ_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
sourceTex,
0);
glBindFramebuffer(GL_DRAW_FRAMEBUFFER, entry.drawFBO);
glFramebufferTexture2D(GL_DRAW_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
mirrorTex,
0);
glBindFramebuffer(GL_READ_FRAMEBUFFER, 0);
glBindFramebuffer(GL_DRAW_FRAMEBUFFER, 0);
entry.mirrorTex = mirrorTex;
entry.width = width;
entry.height = height;
entry.hasMirror = true;
// Wrap the mirror as a CanvasMirrorTextureGLImpl so its destructor
// can clear the entry's mirror fields when the wrapping
// RiveRenderImage is dropped (e.g. when the Lua script GCs the
// bind group containing the view).
auto mirrorTexture =
rcp<TextureGLImpl>(new CanvasMirrorTextureGLImpl(width,
height,
mirrorTex,
m_capabilities,
this,
sourceTex));
auto mirrorImage = make_rcp<RiveRenderImage>(std::move(mirrorTexture));
// The constructor mutated GL FBO/texture bindings; invalidate
// Rive's GLState cache so subsequent rendering re-applies state.
m_state->invalidate();
return mirrorImage;
}
void RenderContextGLImpl::blitMirrorIfRegistered(GLuint targetTex)
{
auto it = m_canvasMirrors.find(targetTex);
if (it == m_canvasMirrors.end() || !it->second.hasMirror)
{
// Either not a canvas target or no consumer has imported it yet.
// Common case for non-canvas flushes: O(1) hash miss.
return;
}
const RenderContextGLImpl::CanvasMirrorEntry& entry = it->second;
// Run the Y-flip blit. Source row 0 (visual bottom) → mirror row
// (h-1) (= visual top under WGSL convention). The destination rect's
// Y is reversed, the source rect is left untouched — that's the
// entire flip, computed by the GPU's hardware blitter.
glBindFramebuffer(GL_READ_FRAMEBUFFER, entry.readFBO);
glBindFramebuffer(GL_DRAW_FRAMEBUFFER, entry.drawFBO);
glBlitFramebuffer(0,
0,
entry.width,
entry.height, // src
0,
entry.height,
entry.width,
0, // dst (Y rev)
GL_COLOR_BUFFER_BIT,
GL_NEAREST);
glBindFramebuffer(GL_READ_FRAMEBUFFER, 0);
glBindFramebuffer(GL_DRAW_FRAMEBUFFER, 0);
// The blit mutated GL FBO/state that Rive's GLState cache tracks.
// Invalidate so any subsequent Rive rendering re-applies state.
m_state->invalidate();
}
// Out-of-line definition for CanvasMirrorTextureGLImpl::~ — needs the
// full RenderContextGLImpl interface to access m_canvasMirrors.
CanvasMirrorTextureGLImpl::~CanvasMirrorTextureGLImpl()
{
if (m_owner == nullptr)
{
return;
}
auto it = m_owner->m_canvasMirrors.find(m_sourceTexID);
if (it == m_owner->m_canvasMirrors.end())
{
// Source canvas was already destroyed (and unregisterCanvasTarget
// freed our FBOs). Nothing to clean up here.
return;
}
RenderContextGLImpl::CanvasMirrorEntry& entry = it->second;
if (entry.readFBO != 0)
{
glDeleteFramebuffers(1, &entry.readFBO);
entry.readFBO = 0;
}
if (entry.drawFBO != 0)
{
glDeleteFramebuffers(1, &entry.drawFBO);
entry.drawFBO = 0;
}
entry.mirrorTex = 0;
entry.hasMirror = false;
// Leave the entry in the map — the source canvas is still alive and
// a future getOrCreateCanvasMirror call must be able to find it.
}
#endif
// BufferRingImpl in GL on a given buffer target. In order to support WebGL2, we
// don't do hardware mapping.
class BufferRingGLImpl : public BufferRing
{
public:
static std::unique_ptr<BufferRingGLImpl> Make(size_t capacityInBytes,
GLenum target,
rcp<GLState> state)
{
return capacityInBytes != 0
? std::unique_ptr<BufferRingGLImpl>(
new BufferRingGLImpl(target,
capacityInBytes,
std::move(state)))
: nullptr;
}
~BufferRingGLImpl() { m_state->deleteBuffer(m_bufferID); }
GLuint bufferID() const { return m_bufferID; }
protected:
BufferRingGLImpl(GLenum target,
size_t capacityInBytes,
rcp<GLState> state) :
BufferRing(capacityInBytes), m_target(target), m_state(std::move(state))
{
glGenBuffers(1, &m_bufferID);
m_state->bindBuffer(m_target, m_bufferID);
glBufferData(m_target, capacityInBytes, nullptr, GL_DYNAMIC_DRAW);
}
void* onMapBuffer(int bufferIdx, size_t mapSizeInBytes) override
{
#ifndef RIVE_WEBGL
// WebGL doesn't support buffer mapping. Don't use it on ANGLE either
// since we don't trust ANGLE with features that haven't been validated
// by WebGL.
if (!m_state->capabilities().isANGLESystemDriver)
{
m_state->bindBuffer(m_target, m_bufferID);
return glMapBufferRange(m_target,
0,
mapSizeInBytes,
GL_MAP_WRITE_BIT |
GL_MAP_INVALIDATE_BUFFER_BIT);
}
else
#endif
{
return shadowBuffer();
}
}
void onUnmapAndSubmitBuffer(int bufferIdx, size_t mapSizeInBytes) override
{
m_state->bindBuffer(m_target, m_bufferID);
#ifndef RIVE_WEBGL
// WebGL doesn't support buffer mapping. Don't use it on ANGLE either
// since we don't trust ANGLE with features that haven't been validated
// by WebGL.
if (!m_state->capabilities().isANGLESystemDriver)
{
glUnmapBuffer(m_target);
}
else
#endif
{
glBufferSubData(m_target, 0, mapSizeInBytes, shadowBuffer());
}
}
const GLenum m_target;
GLuint m_bufferID;
const rcp<GLState> m_state;
};
// GL internalformat to use for a texture that polyfills a storage buffer.
static GLenum storage_texture_internalformat(
gpu::StorageBufferStructure bufferStructure)
{
switch (bufferStructure)
{
case gpu::StorageBufferStructure::uint32x4:
return GL_RGBA32UI;
case gpu::StorageBufferStructure::uint32x2:
return GL_RG32UI;
case gpu::StorageBufferStructure::float32x4:
return GL_RGBA32F;
}
RIVE_UNREACHABLE();
}
// GL format to use for a texture that polyfills a storage buffer.
static GLenum storage_texture_format(
gpu::StorageBufferStructure bufferStructure)
{
switch (bufferStructure)
{
case gpu::StorageBufferStructure::uint32x4:
return GL_RGBA_INTEGER;
case gpu::StorageBufferStructure::uint32x2:
return GL_RG_INTEGER;
case gpu::StorageBufferStructure::float32x4:
return GL_RGBA;
}
RIVE_UNREACHABLE();
}
// GL type to use for a texture that polyfills a storage buffer.
static GLenum storage_texture_type(gpu::StorageBufferStructure bufferStructure)
{
switch (bufferStructure)
{
case gpu::StorageBufferStructure::uint32x4:
return GL_UNSIGNED_INT;
case gpu::StorageBufferStructure::uint32x2:
return GL_UNSIGNED_INT;
case gpu::StorageBufferStructure::float32x4:
return GL_FLOAT;
}
RIVE_UNREACHABLE();
}
class StorageBufferRingGLImpl : public BufferRingGLImpl
{
public:
StorageBufferRingGLImpl(size_t capacityInBytes,
gpu::StorageBufferStructure bufferStructure,
rcp<GLState> state) :
BufferRingGLImpl(
// If we don't support storage buffers, instead make a pixel-unpack
// buffer that will be used to copy data into the polyfill texture.
GL_SHADER_STORAGE_BUFFER,
capacityInBytes,
std::move(state)),
m_bufferStructure(bufferStructure)
{}
void bindToRenderContext(uint32_t bindingIdx,
size_t bindingSizeInBytes,
size_t offsetSizeInBytes) const
{
glBindBufferRange(GL_SHADER_STORAGE_BUFFER,
bindingIdx,
bufferID(),
offsetSizeInBytes,
bindingSizeInBytes);
}
protected:
const gpu::StorageBufferStructure m_bufferStructure;
};
class TexelBufferRingWebGL : public BufferRing
{
public:
TexelBufferRingWebGL(size_t capacityInBytes,
gpu::StorageBufferStructure bufferStructure,
rcp<GLState> state) :
BufferRing(
gpu::StorageTextureBufferSize(capacityInBytes, bufferStructure)),
m_bufferStructure(bufferStructure),
m_state(std::move(state))
{
auto [width, height] =
gpu::StorageTextureSize(capacityInBytes, m_bufferStructure);
GLenum internalformat =
storage_texture_internalformat(m_bufferStructure);
glGenTextures(1, &m_textureID);
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, m_textureID);
glTexStorage2D(GL_TEXTURE_2D, 1, internalformat, width, height);
glutils::SetTexture2DSamplingParams(GL_NEAREST, GL_NEAREST);
glBindTexture(GL_TEXTURE_2D, 0);
}
~TexelBufferRingWebGL() { glDeleteTextures(1, &m_textureID); }
void* onMapBuffer(int bufferIdx, size_t mapSizeInBytes) override
{
return shadowBuffer();
}
void onUnmapAndSubmitBuffer(int bufferIdx, size_t mapSizeInBytes) override
{}
void bindToRenderContext(uint32_t bindingIdx,
size_t bindingSizeInBytes,
size_t offsetSizeInBytes) const
{
auto [updateWidth, updateHeight] =
gpu::StorageTextureSize(bindingSizeInBytes, m_bufferStructure);
glActiveTexture(GL_TEXTURE0 + bindingIdx);
glBindTexture(GL_TEXTURE_2D, m_textureID);
glTexSubImage2D(GL_TEXTURE_2D,
0,
0,
0,
updateWidth,
updateHeight,
storage_texture_format(m_bufferStructure),
storage_texture_type(m_bufferStructure),
shadowBuffer() + offsetSizeInBytes);
}
protected:
const gpu::StorageBufferStructure m_bufferStructure;
const rcp<GLState> m_state;
GLuint m_textureID;
};
std::unique_ptr<BufferRing> RenderContextGLImpl::makeUniformBufferRing(
size_t capacityInBytes)
{
return BufferRingGLImpl::Make(capacityInBytes, GL_UNIFORM_BUFFER, m_state);
}
std::unique_ptr<BufferRing> RenderContextGLImpl::makeStorageBufferRing(
size_t capacityInBytes,
gpu::StorageBufferStructure bufferStructure)
{
if (capacityInBytes == 0)
{
return nullptr;
}
else if (m_capabilities.ARB_shader_storage_buffer_object)
{
return std::make_unique<StorageBufferRingGLImpl>(capacityInBytes,
bufferStructure,
m_state);
}
else
{
return std::make_unique<TexelBufferRingWebGL>(capacityInBytes,
bufferStructure,
m_state);
}
}
std::unique_ptr<BufferRing> RenderContextGLImpl::makeVertexBufferRing(
size_t capacityInBytes)
{
return BufferRingGLImpl::Make(capacityInBytes, GL_ARRAY_BUFFER, m_state);
}
void RenderContextGLImpl::resizeGradientTexture(uint32_t width, uint32_t height)
{
glDeleteTextures(1, &m_gradientTexture);
if (width == 0 || height == 0)
{
m_gradientTexture = 0;
}
else
{
glGenTextures(1, &m_gradientTexture);
glActiveTexture(GL_TEXTURE0 + GRAD_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_gradientTexture);
glTexStorage2D(GL_TEXTURE_2D, 1, GL_RGBA8, width, height);
glutils::SetTexture2DSamplingParams(GL_LINEAR, GL_LINEAR);
}
glBindFramebuffer(GL_FRAMEBUFFER, m_colorRampFBO);
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_gradientTexture,
0);
}
void RenderContextGLImpl::resizeTessellationTexture(uint32_t width,
uint32_t height)
{
glDeleteTextures(1, &m_tessVertexTexture);
if (width == 0 || height == 0)
{
m_tessVertexTexture = 0;
}
else
{
glGenTextures(1, &m_tessVertexTexture);
glActiveTexture(GL_TEXTURE0 + TESS_VERTEX_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_tessVertexTexture);
glTexStorage2D(GL_TEXTURE_2D,
1,
m_capabilities.needsFloatingPointTessellationTexture
? GL_RGBA32F
: GL_RGBA32UI,
width,
height);
glutils::SetTexture2DSamplingParams(GL_NEAREST, GL_NEAREST);
}
glBindFramebuffer(GL_FRAMEBUFFER, m_tessellateFBO);
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_tessVertexTexture,
0);
}
void RenderContextGLImpl::AtlasProgram::compile(
GLuint vertexShaderID,
const char* defines[],
size_t numDefines,
const char* sources[],
size_t numSources,
const GLCapabilities& capabilities,
GLState* state)
{
m_program = glutils::Program();
glAttachShader(m_program, vertexShaderID);
m_program.compileAndAttachShader(GL_FRAGMENT_SHADER,
defines,
numDefines,
sources,
numSources,
capabilities);
m_program.link();
state->bindProgram(m_program);
glUniformBlockBinding(m_program,
glGetUniformBlockIndex(m_program, GLSL_FlushUniforms),
FLUSH_UNIFORM_BUFFER_IDX);
glutils::Uniform1iByName(m_program,
GLSL_tessVertexTexture,
TESS_VERTEX_TEXTURE_IDX);
glutils::Uniform1iByName(m_program,
GLSL_featherTexture,
FEATHER_TEXTURE_IDX);
if (!capabilities.ARB_shader_storage_buffer_object)
{
glutils::Uniform1iByName(m_program, GLSL_pathBuffer, PATH_BUFFER_IDX);
glutils::Uniform1iByName(m_program,
GLSL_contourBuffer,
CONTOUR_BUFFER_IDX);
}
if (!capabilities.ANGLE_base_vertex_base_instance_shader_builtin)
{
m_baseInstanceUniformLocation =
glGetUniformLocation(m_program,
glutils::BASE_INSTANCE_UNIFORM_NAME);
}
}
static GLenum atlas_render_format(
RenderContextGLImpl::AtlasRenderType atlasRenderType)
{
switch (atlasRenderType)
{
using AtlasRenderType = RenderContextGLImpl::AtlasRenderType;
case AtlasRenderType::r16f:
return GL_R16F;
case AtlasRenderType::r32f:
return GL_R32F;
case AtlasRenderType::r32uiFramebufferFetch:
return GL_R32UI;
case AtlasRenderType::r8PixelLocalStorageEXT:
return GL_R8;
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
return GL_R32UI;
case AtlasRenderType::r32iAtomicTexture:
return GL_R32I;
case AtlasRenderType::rgba8:
return GL_RGBA8;
}
RIVE_UNREACHABLE();
}
void RenderContextGLImpl::resizeAtlasTexture(uint32_t width, uint32_t height)
{
m_atlasRenderTexture = glutils::Texture::Zero();
m_atlasTexture = glutils::Texture::Zero();
m_atlasRenderFBO = glutils::Framebuffer::Zero();
m_atlasResolveFBO = glutils::Framebuffer::Zero();
if (width == 0 || height == 0)
{
return;
}
const GLenum atlasRenderFormat = atlas_render_format(m_atlasRenderType);
const bool canSampleAtlasRenderFormat =
atlasRenderFormat == GL_R8 ||
(atlasRenderFormat == GL_R16F &&
m_capabilities.OES_texture_half_float_linear);
if (!canSampleAtlasRenderFormat)
{
// The atlas format we render to cannot be sampled. Create a separate
// texture for rendering that will be resolved into the main (GL_R8)
// atlas texture.
m_atlasRenderTexture = glutils::Texture();
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, m_atlasRenderTexture);
glTexStorage2D(GL_TEXTURE_2D, 1, atlasRenderFormat, width, height);
glutils::SetTexture2DSamplingParams(GL_NEAREST, GL_NEAREST);
}
m_atlasTexture = glutils::Texture();
glActiveTexture(GL_TEXTURE0 + ATLAS_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, m_atlasTexture);
glTexStorage2D(GL_TEXTURE_2D,
1,
canSampleAtlasRenderFormat ? atlasRenderFormat : GL_R8,
width,
height);
glutils::SetTexture2DSamplingParams(GL_LINEAR, GL_LINEAR);
if (m_atlasVertexShader == 0)
{
// Don't compile the atlas programs until we get an indication that
// they will be used.
// FIXME: Do this in parallel at startup!!
buildAtlasRenderPipelines();
}
m_atlasRenderFBO = glutils::Framebuffer();
glBindFramebuffer(GL_FRAMEBUFFER, m_atlasRenderFBO);
switch (m_atlasRenderType)
{
case AtlasRenderType::r16f:
case AtlasRenderType::r32f:
case AtlasRenderType::rgba8:
case AtlasRenderType::r32iAtomicTexture:
{
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
(m_atlasRenderTexture != 0)
? m_atlasRenderTexture
: m_atlasTexture,
0);
if (m_atlasRenderTexture != 0)
{
// The atlas will be resolved in a separate render pass or blit.
m_atlasResolveFBO = glutils::Framebuffer();
glBindFramebuffer(GL_FRAMEBUFFER, m_atlasResolveFBO);
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_atlasTexture,
0);
}
break;
}
case AtlasRenderType::r32uiFramebufferFetch:
{
// Use MRT to render and resolve the atlas in a single render pass.
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_atlasRenderTexture,
0);
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT1,
GL_TEXTURE_2D,
m_atlasTexture,
0);
glDrawBuffers(2,
std::array<GLenum, 2>{GL_COLOR_ATTACHMENT0,
GL_COLOR_ATTACHMENT1}
.data());
break;
}
case AtlasRenderType::r8PixelLocalStorageEXT:
{
#ifdef RIVE_ANDROID
// EXT_shader_pixel_local_storage can just resolve and output the
// render pass at the end of the PLS render pass.
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_atlasTexture,
0);
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
{
#ifndef RIVE_ANDROID
// ANGLE_shader_pixel_local_storage can just resolve and output the
// render pass at the end of the PLS render pass.
assert(m_atlasRenderTexture != 0);
glFramebufferTexturePixelLocalStorageANGLE(0,
m_atlasRenderTexture,
0,
0,
GL_NONE);
glFramebufferTexture2D(GL_FRAMEBUFFER,
GL_COLOR_ATTACHMENT0,
GL_TEXTURE_2D,
m_atlasTexture,
0);
#else
RIVE_UNREACHABLE();
#endif
break;
}
}
}
void RenderContextGLImpl::resizeTransientPLSBacking(uint32_t width,
uint32_t height,
uint32_t planeCount)
{
if (m_plsImpl != nullptr)
{
m_plsImpl->resizeTransientPLSBacking(width, height, planeCount);
}
else
{
// If we don't support PLS we better not be allocating a backing for it.
assert((width | height | planeCount) == 0);
}
}
void RenderContextGLImpl::resizeAtomicCoverageBacking(uint32_t width,
uint32_t height)
{
if (m_plsImpl != nullptr)
{
m_plsImpl->resizeAtomicCoverageBacking(width, height);
}
else
{
// If we don't support PLS we better not be allocating a backing for it.
assert((width | height) == 0);
}
}
RenderContextGLImpl::DrawShader::DrawShader(
RenderContextGLImpl* renderContextImpl,
GLenum shaderType,
gpu::DrawType drawType,
ShaderFeatures shaderFeatures,
gpu::InterlockMode interlockMode,
gpu::ShaderMiscFlags shaderMiscFlags)
{
#ifdef DISABLE_PLS_ATOMICS
if (interlockMode == gpu::InterlockMode::atomics)
{
// Don't draw anything in atomic mode if support for it isn't compiled
// in.
return;
}
#endif
std::vector<const char*> defines;
if (renderContextImpl->m_plsImpl != nullptr)
{
renderContextImpl->m_plsImpl->pushShaderDefines(interlockMode,
&defines);
}
if (interlockMode == gpu::InterlockMode::atomics)
{
// Atomics are currently always done on storage textures.
defines.push_back(GLSL_USING_PLS_STORAGE_TEXTURES);
}
if (enums::is_flag_set(shaderMiscFlags,
gpu::ShaderMiscFlags::fixedFunctionColorOutput))
{
defines.push_back(GLSL_FIXED_FUNCTION_COLOR_OUTPUT);
}
if (enums::is_flag_set(shaderMiscFlags,
gpu::ShaderMiscFlags::clockwiseFill))
{
defines.push_back(GLSL_CLOCKWISE_FILL);
}
if (enums::is_flag_set(shaderMiscFlags,
gpu::ShaderMiscFlags::borrowedCoveragePass))
{
defines.push_back(GLSL_BORROWED_COVERAGE_PASS);
}
for (size_t i = 0; i < kShaderFeatureCount; ++i)
{
const auto feature = ShaderFeatures(1 << i);
if (enums::is_flag_set(shaderFeatures, feature))
{
assert(enums::is_flag_set(kVertexShaderFeaturesMask, feature) ||
shaderType == GL_FRAGMENT_SHADER);
if (interlockMode == gpu::InterlockMode::msaa &&
feature == gpu::ShaderFeatures::ENABLE_ADVANCED_BLEND &&
renderContextImpl->m_capabilities.KHR_blend_equation_advanced)
{
defines.push_back(GLSL_ENABLE_KHR_BLEND);
}
else
{
defines.push_back(GetShaderFeatureGLSLName(feature));
}
}
}
if (interlockMode == gpu::InterlockMode::msaa)
{
defines.push_back(GLSL_RENDER_MODE_MSAA);
}
assert(renderContextImpl->platformFeatures().framebufferBottomUp);
defines.push_back(GLSL_FRAMEBUFFER_BOTTOM_UP);
if (!renderContextImpl->m_capabilities.ARB_shader_storage_buffer_object)
{
defines.push_back(GLSL_DISABLE_SHADER_STORAGE_BUFFERS);
}
switch (drawType)
{
case gpu::DrawType::midpointFanPatches:
case gpu::DrawType::midpointFanCenterAAPatches:
case gpu::DrawType::outerCurvePatches:
case gpu::DrawType::msaaStrokes:
case gpu::DrawType::msaaMidpointFanBorrowedCoverage:
case gpu::DrawType::msaaMidpointFans:
case gpu::DrawType::msaaMidpointFanStencilReset:
case gpu::DrawType::msaaMidpointFanPathsStencil:
case gpu::DrawType::msaaMidpointFanPathsCover:
case gpu::DrawType::msaaOuterCubics:
if (shaderType == GL_VERTEX_SHADER)
{
defines.push_back(GLSL_ENABLE_INSTANCE_INDEX);
}
defines.push_back(GLSL_DRAW_PATH);
break;
case gpu::DrawType::clipReset:
break;
case gpu::DrawType::interiorTriangulation:
defines.push_back(GLSL_DRAW_INTERIOR_TRIANGLES);
break;
case gpu::DrawType::atlasBlit:
defines.push_back(GLSL_ATLAS_BLIT);
break;
case gpu::DrawType::imageRect:
assert(interlockMode == gpu::InterlockMode::atomics);
defines.push_back(GLSL_DRAW_IMAGE);
defines.push_back(GLSL_DRAW_IMAGE_RECT);
break;
case gpu::DrawType::imageMesh:
defines.push_back(GLSL_DRAW_IMAGE);
defines.push_back(GLSL_DRAW_IMAGE_MESH);
break;
case gpu::DrawType::renderPassResolve:
assert(interlockMode == gpu::InterlockMode::atomics);
defines.push_back(GLSL_DRAW_RENDER_TARGET_UPDATE_BOUNDS);
defines.push_back(GLSL_RESOLVE_PLS);
if (enums::is_flag_set(
shaderMiscFlags,
gpu::ShaderMiscFlags::coalescedResolveAndTransfer))
{
assert(shaderType == GL_FRAGMENT_SHADER);
defines.push_back(GLSL_COALESCED_PLS_RESOLVE_AND_TRANSFER);
}
break;
case gpu::DrawType::renderPassInitialize:
RIVE_UNREACHABLE();
}
std::vector<const char*> sources;
if (renderContextImpl->platformFeatures().avoidFlatVaryings)
{
sources.push_back("#define " GLSL_OPTIONALLY_FLAT "\n");
}
else
{
sources.push_back("#define " GLSL_OPTIONALLY_FLAT " flat\n");
}
sources.push_back(glsl::constants);
sources.push_back(glsl::flush_uniforms);
sources.push_back(glsl::common);
if (shaderType == GL_FRAGMENT_SHADER &&
enums::is_flag_set(shaderFeatures,
ShaderFeatures::ENABLE_ADVANCED_BLEND))
{
sources.push_back(glsl::advanced_blend);
}
switch (interlockMode)
{
case gpu::InterlockMode::rasterOrdering:
case gpu::InterlockMode::clockwise:
switch (drawType)
{
case gpu::DrawType::midpointFanPatches:
case gpu::DrawType::midpointFanCenterAAPatches:
case gpu::DrawType::outerCurvePatches:
case gpu::DrawType::interiorTriangulation:
sources.push_back(gpu::glsl::draw_path_common);
sources.push_back(gpu::glsl::draw_path_vert);
sources.push_back(
(interlockMode == gpu::InterlockMode::clockwise)
? enums::is_flag_set(
shaderMiscFlags,
gpu::ShaderMiscFlags::clipUpdateOnly)
? gpu::glsl::draw_clockwise_clip_frag
: gpu::glsl::draw_clockwise_path_frag
: gpu::glsl::draw_raster_order_path_frag);
break;
case gpu::DrawType::atlasBlit:
sources.push_back(gpu::glsl::draw_path_common);
sources.push_back(gpu::glsl::draw_path_vert);
sources.push_back(gpu::glsl::draw_mesh_frag);
break;
case gpu::DrawType::imageMesh:
sources.push_back(gpu::glsl::image_draw_uniforms);
sources.push_back(gpu::glsl::draw_image_mesh_vert);
sources.push_back(gpu::glsl::draw_mesh_frag);
break;
case gpu::DrawType::imageRect:
case gpu::DrawType::msaaStrokes:
case gpu::DrawType::msaaMidpointFanBorrowedCoverage:
case gpu::DrawType::msaaMidpointFans:
case gpu::DrawType::msaaMidpointFanStencilReset:
case gpu::DrawType::msaaMidpointFanPathsStencil:
case gpu::DrawType::msaaMidpointFanPathsCover:
case gpu::DrawType::msaaOuterCubics:
case gpu::DrawType::clipReset:
case gpu::DrawType::renderPassInitialize:
case gpu::DrawType::renderPassResolve:
RIVE_UNREACHABLE();
}
break;
case gpu::InterlockMode::atomics:
if (gpu::DrawTypeIsImageDraw(drawType))
{
sources.push_back(gpu::glsl::image_draw_uniforms);
}
sources.push_back(gpu::glsl::draw_path_common);
sources.push_back(gpu::glsl::atomic_draw);
break;
case gpu::InterlockMode::msaa:
switch (drawType)
{
case gpu::DrawType::msaaStrokes:
case gpu::DrawType::msaaMidpointFanBorrowedCoverage:
case gpu::DrawType::msaaMidpointFans:
case gpu::DrawType::msaaMidpointFanStencilReset:
case gpu::DrawType::msaaMidpointFanPathsStencil:
case gpu::DrawType::msaaMidpointFanPathsCover:
case gpu::DrawType::msaaOuterCubics:
case gpu::DrawType::interiorTriangulation:
sources.push_back(gpu::glsl::draw_path_common);
sources.push_back(gpu::glsl::draw_path_vert);
sources.push_back(gpu::glsl::draw_msaa_object_frag);
break;
case gpu::DrawType::clipReset:
sources.push_back(gpu::glsl::stencil_draw);
break;
case gpu::DrawType::atlasBlit:
sources.push_back(gpu::glsl::draw_path_common);
sources.push_back(gpu::glsl::draw_path_vert);
sources.push_back(gpu::glsl::draw_msaa_object_frag);
break;
case gpu::DrawType::imageMesh:
sources.push_back(glsl::image_draw_uniforms);
sources.push_back(gpu::glsl::draw_image_mesh_vert);
sources.push_back(gpu::glsl::draw_msaa_object_frag);
break;
case gpu::DrawType::midpointFanPatches:
case gpu::DrawType::midpointFanCenterAAPatches:
case gpu::DrawType::outerCurvePatches:
case gpu::DrawType::imageRect:
case gpu::DrawType::renderPassInitialize:
case gpu::DrawType::renderPassResolve:
RIVE_UNREACHABLE();
}
break;
case gpu::InterlockMode::clockwiseAtomic:
RIVE_UNREACHABLE();
}
m_id = glutils::CompileShader(shaderType,
defines.data(),
defines.size(),
sources.data(),
sources.size(),
renderContextImpl->m_capabilities,
glutils::DebugPrintErrorAndAbort::no);
}
RenderContextGLImpl::DrawShader::DrawShader(DrawShader&& moveFrom) :
m_id(std::exchange(moveFrom.m_id, 0))
{}
RenderContextGLImpl::DrawShader& RenderContextGLImpl::DrawShader ::operator=(
DrawShader&& moveFrom)
{
if (&moveFrom != this)
{
if (m_id != 0)
{
glDeleteShader(m_id);
}
m_id = std::exchange(moveFrom.m_id, 0);
}
return *this;
}
RenderContextGLImpl::DrawShader::~DrawShader()
{
if (m_id != 0)
{
glDeleteShader(m_id);
}
}
RenderContextGLImpl::DrawProgram::DrawProgram(
RenderContextGLImpl* renderContextImpl,
PipelineCreateType createType,
gpu::DrawType drawType,
gpu::ShaderFeatures shaderFeatures,
gpu::InterlockMode interlockMode,
gpu::ShaderMiscFlags shaderMiscFlags
#ifdef WITH_RIVE_TOOLS
,
SynthesizedFailureType synthesizedFailureType
#endif
) :
m_state(renderContextImpl->m_state)
{
#ifdef WITH_RIVE_TOOLS
m_synthesizedFailureType = synthesizedFailureType;
if (m_synthesizedFailureType == SynthesizedFailureType::shaderCompilation)
{
m_pipelineStatus = PipelineStatus::errored;
return;
}
#endif
m_vertexShader =
&renderContextImpl->m_pipelineManager.getVertexShaderSynchronous(
drawType,
shaderFeatures,
interlockMode);
m_fragmentShader =
&renderContextImpl->m_pipelineManager.getFragmentShaderSynchronous(
drawType,
shaderFeatures,
interlockMode,
shaderMiscFlags);
m_id = glCreateProgram();
// In async mode, we do not need to wait for the shaders to finish compiling
// before doing the link - the link is what we actually can poll to ensure
// everything finishes. If the linking fails, that is where we can check the
// compilation statuses and display compilation errors as needed.
glAttachShader(m_id, m_vertexShader->id());
glAttachShader(m_id, m_fragmentShader->id());
glutils::LinkProgram(m_id, glutils::DebugPrintErrorAndAbort::no);
std::ignore = advanceCreation(renderContextImpl,
createType,
drawType,
shaderFeatures,
interlockMode,
shaderMiscFlags);
}
bool RenderContextGLImpl::DrawProgram::advanceCreation(
RenderContextGLImpl* renderContextImpl,
PipelineCreateType createType,
gpu::DrawType drawType,
ShaderFeatures shaderFeatures,
gpu::InterlockMode interlockMode,
gpu::ShaderMiscFlags shaderMiscFlags)
{
// This function should only be called if we're in the middle of creation.
assert(m_pipelineStatus == PipelineStatus::notReady);
if (createType == PipelineCreateType::async &&
renderContextImpl->capabilities().KHR_parallel_shader_compile)
{
// Like above, this is async creation so verify the program is linked
// before continuing.
GLint completed = 0;
glGetProgramiv(m_id, GL_COMPLETION_STATUS_KHR, &completed);
if (completed == 0)
{
return false;
}
}
#ifdef WITH_RIVE_TOOLS
if (m_synthesizedFailureType == SynthesizedFailureType::pipelineCreation)
{
m_pipelineStatus = PipelineStatus::errored;
return false;
}
#endif
{
GLint successfullyLinked = 0;
glGetProgramiv(m_id, GL_LINK_STATUS, &successfullyLinked);
if (successfullyLinked == GL_FALSE)
{
#ifdef DEBUG
// The link failed, which might have been caused by compilation
// failures, so output any compilation failure messages first.
GLint compiledSuccessfully = 0;
glGetShaderiv(m_vertexShader->id(),
GL_COMPILE_STATUS,
&compiledSuccessfully);
if (compiledSuccessfully == GL_FALSE)
{
glutils::PrintShaderCompilationErrors(m_vertexShader->id());
}
glGetShaderiv(m_fragmentShader->id(),
GL_COMPILE_STATUS,
&compiledSuccessfully);
if (compiledSuccessfully == GL_FALSE)
{
glutils::PrintShaderCompilationErrors(m_fragmentShader->id());
}
glutils::PrintLinkProgramErrors(m_id);
#endif
m_pipelineStatus = PipelineStatus::errored;
return false;
}
}
m_state->bindProgram(m_id);
glUniformBlockBinding(m_id,
glGetUniformBlockIndex(m_id, GLSL_FlushUniforms),
FLUSH_UNIFORM_BUFFER_IDX);
const bool isImageDraw = gpu::DrawTypeIsImageDraw(drawType);
const bool isTessellationDraw = is_tessellation_draw(drawType);
const bool isPaintDraw =
(isTessellationDraw ||
drawType == gpu::DrawType::interiorTriangulation ||
drawType == gpu::DrawType::atlasBlit) &&
enums::no_flags_set(shaderMiscFlags,
gpu::ShaderMiscFlags::clipUpdateOnly |
gpu::ShaderMiscFlags::borrowedCoveragePass);
if (isImageDraw)
{
glUniformBlockBinding(
m_id,
glGetUniformBlockIndex(m_id, GLSL_ImageDrawUniforms),
IMAGE_DRAW_UNIFORM_BUFFER_IDX);
}
if (isTessellationDraw)
{
glutils::Uniform1iByName(m_id,
GLSL_tessVertexTexture,
TESS_VERTEX_TEXTURE_IDX);
}
// Since atomic mode emits the color of the *previous* path, it needs the
// gradient texture bound for every draw.
if (isPaintDraw || interlockMode == gpu::InterlockMode::atomics)
{
glutils::Uniform1iByName(m_id, GLSL_gradTexture, GRAD_TEXTURE_IDX);
}
if (isTessellationDraw &&
enums::is_flag_set(shaderFeatures, ShaderFeatures::ENABLE_FEATHER))
{
assert(isPaintDraw || interlockMode == gpu::InterlockMode::atomics);
glutils::Uniform1iByName(m_id,
GLSL_featherTexture,
FEATHER_TEXTURE_IDX);
}
// Atomic mode doesn't support image paints on paths.
if (drawType == gpu::DrawType::atlasBlit)
{
glutils::Uniform1iByName(m_id, GLSL_atlasTexture, ATLAS_TEXTURE_IDX);
}
if (isImageDraw ||
(isPaintDraw && interlockMode != gpu::InterlockMode::atomics))
{
glutils::Uniform1iByName(m_id, GLSL_imageTexture, IMAGE_TEXTURE_IDX);
}
if (!renderContextImpl->m_capabilities.ARB_shader_storage_buffer_object)
{
// Our GL driver doesn't support storage buffers. We polyfill these
// buffers as textures.
if (isPaintDraw)
{
glutils::Uniform1iByName(m_id, GLSL_pathBuffer, PATH_BUFFER_IDX);
}
if (isPaintDraw || interlockMode == gpu::InterlockMode::atomics)
{
glutils::Uniform1iByName(m_id, GLSL_paintBuffer, PAINT_BUFFER_IDX);
glutils::Uniform1iByName(m_id,
GLSL_paintAuxBuffer,
PAINT_AUX_BUFFER_IDX);
}
if (isTessellationDraw)
{
glutils::Uniform1iByName(m_id,
GLSL_contourBuffer,
CONTOUR_BUFFER_IDX);
}
}
if (interlockMode == gpu::InterlockMode::msaa &&
enums::is_flag_set(shaderFeatures,
gpu::ShaderFeatures::ENABLE_ADVANCED_BLEND) &&
!renderContextImpl->m_capabilities.KHR_blend_equation_advanced &&
!enums::is_flag_set(shaderMiscFlags,
gpu::ShaderMiscFlags::fixedFunctionColorOutput))
{
glutils::Uniform1iByName(m_id,
GLSL_dstColorTexture,
DST_COLOR_TEXTURE_IDX);
}
if (!renderContextImpl->m_capabilities
.ANGLE_base_vertex_base_instance_shader_builtin)
{
m_baseInstanceUniformLocation =
glGetUniformLocation(m_id, glutils::BASE_INSTANCE_UNIFORM_NAME);
}
// All done! This program is now usable by the renderer.
m_pipelineStatus = PipelineStatus::ready;
return true;
}
RenderContextGLImpl::DrawProgram::~DrawProgram()
{
if (m_id != 0)
{
m_state->deleteProgram(m_id);
}
}
static GLuint gl_buffer_id(const BufferRing* bufferRing)
{
return static_cast<const BufferRingGLImpl*>(bufferRing)->bufferID();
}
static void bind_storage_buffer(const GLCapabilities& capabilities,
const BufferRing* bufferRing,
uint32_t bindingIdx,
size_t bindingSizeInBytes,
size_t offsetSizeInBytes)
{
assert(bufferRing != nullptr);
assert(bindingSizeInBytes > 0);
if (capabilities.ARB_shader_storage_buffer_object)
{
static_cast<const StorageBufferRingGLImpl*>(bufferRing)
->bindToRenderContext(bindingIdx,
bindingSizeInBytes,
offsetSizeInBytes);
}
else
{
static_cast<const TexelBufferRingWebGL*>(bufferRing)
->bindToRenderContext(bindingIdx,
bindingSizeInBytes,
offsetSizeInBytes);
}
}
void RenderContextGLImpl::PixelLocalStorageImpl::ensureRasterOrderingEnabled(
RenderContextGLImpl* renderContextImpl,
const gpu::FlushDescriptor& desc,
bool enabled)
{
assert(!enabled ||
renderContextImpl->platformFeatures().supportsRasterOrderingMode ||
renderContextImpl->platformFeatures().supportsClockwiseMode);
auto rasterOrderState = enabled ? gpu::TriState::yes : gpu::TriState::no;
if (m_rasterOrderingEnabled != rasterOrderState)
{
onEnableRasterOrdering(enabled);
m_rasterOrderingEnabled = rasterOrderState;
// We only need a barrier when turning raster ordering OFF, because PLS
// already inserts the necessary barriers after draws when it's
// disabled.
if (m_rasterOrderingEnabled == gpu::TriState::no)
{
onBarrier(desc);
}
}
}
void RenderContextGLImpl::preBeginFrame(RenderContext* ctx)
{
if (!m_testForAdvancedBlendError)
{
return;
}
// We need to do a test to check whether or not KHR_blend_equation_advanced
// actually works as advertised. This is basically done by rendering a
// quad with a fancy blend mode to a tiny render target, reading it back,
// then checking how close to the true color we are.
m_testForAdvancedBlendError = false;
constexpr uint32_t RT_WIDTH = 4;
constexpr uint32_t RT_HEIGHT = 4;
constexpr ColorInt RT_CLEAR_COLOR = 0x8000ffff;
RenderContext::FrameDescriptor fd = {
.renderTargetWidth = RT_WIDTH,
.renderTargetHeight = RT_HEIGHT,
.clearColor = RT_CLEAR_COLOR,
};
glutils::Texture texture;
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, texture);
glTexStorage2D(GL_TEXTURE_2D, 1, GL_RGBA8, RT_WIDTH, RT_HEIGHT);
TextureRenderTargetGL rt{RT_WIDTH, RT_HEIGHT};
rt.setTargetTexture(texture);
ctx->beginFrame(fd);
RiveRenderer renderer{ctx};
constexpr ColorInt RT_QUAD_FILL_COLOR = 0x80404000;
auto paint = ctx->makeRenderPaint();
paint->style(RenderPaintStyle::fill);
paint->color(RT_QUAD_FILL_COLOR);
paint->blendMode(BlendMode::colorBurn);
auto path = ctx->makeEmptyRenderPath();
path->fillRule(FillRule::clockwise);
path->moveTo(-1.0f, -1.0f);
path->lineTo(float(RT_WIDTH + 1), -1.0f);
path->lineTo(float(RT_WIDTH + 1), float(RT_HEIGHT + 1));
path->lineTo(-1.0f, float(RT_HEIGHT + 1));
renderer.drawPath(path.get(), paint.get());
ctx->flush({.renderTarget = &rt});
rt.bindDestinationFramebuffer(GL_READ_FRAMEBUFFER);
uint8_t pixel[4];
glReadPixels(1, 1, 1, 1, GL_RGBA, GL_UNSIGNED_BYTE, &pixel);
// Note that this color is *not* in the same channel order as the above
// colors.
uint8_t EXPECTED_COLOR[] = {0x10, 0x90, 0x80, 0xc0};
int maxRGBDiff = std::max({std::abs(int(pixel[0] - EXPECTED_COLOR[0])),
std::abs(int(pixel[1] - EXPECTED_COLOR[1])),
std::abs(int(pixel[2] - EXPECTED_COLOR[2]))});
// Note that the RGB mismatch we are seeing that this is fixing is 96.
constexpr int DIFF_TOLERANCE = 40;
if (maxRGBDiff > DIFF_TOLERANCE)
{
// If the blending was out of tolerance then we need to disable this
// feature.
m_capabilities.KHR_blend_equation_advanced_coherent = false;
m_capabilities.KHR_blend_equation_advanced = false;
m_platformFeatures.supportsBlendAdvancedCoherentKHR = false;
m_platformFeatures.supportsBlendAdvancedKHR = false;
// We also need to clear the shader caches because shaders get built
// differently based on whether KHR_blend_equation_advanced is set.
// Thankfully we should only have a couple that we just created for
// the test.
m_pipelineManager.clearCache();
}
}
void RenderContextGLImpl::flush(const FlushDescriptor& desc)
{
assert(desc.interlockMode != gpu::InterlockMode::clockwiseAtomic);
auto renderTarget = static_cast<RenderTargetGL*>(desc.renderTarget);
// All programs use the same set of per-flush uniforms.
glBindBufferRange(GL_UNIFORM_BUFFER,
FLUSH_UNIFORM_BUFFER_IDX,
gl_buffer_id(flushUniformBufferRing()),
desc.flushUniformDataOffsetInBytes,
sizeof(gpu::FlushUniforms));
// All programs use the same storage buffers.
if (desc.pathCount > 0)
{
bind_storage_buffer(m_capabilities,
pathBufferRing(),
PATH_BUFFER_IDX,
desc.pathCount * sizeof(gpu::PathData),
desc.firstPath * sizeof(gpu::PathData));
bind_storage_buffer(m_capabilities,
paintBufferRing(),
PAINT_BUFFER_IDX,
desc.pathCount * sizeof(gpu::PaintData),
desc.firstPaint * sizeof(gpu::PaintData));
bind_storage_buffer(m_capabilities,
paintAuxBufferRing(),
PAINT_AUX_BUFFER_IDX,
desc.pathCount * sizeof(gpu::PaintAuxData),
desc.firstPaintAux * sizeof(gpu::PaintAuxData));
}
if (desc.contourCount > 0)
{
bind_storage_buffer(m_capabilities,
contourBufferRing(),
CONTOUR_BUFFER_IDX,
desc.contourCount * sizeof(gpu::ContourData),
desc.firstContour * sizeof(gpu::ContourData));
}
GLFlushInjector flushInjector(m_capabilities);
// Render the complex color ramps into the gradient texture.
if (desc.gradSpanCount > 0)
{
if (m_capabilities.isPowerVR)
{
// PowerVR needs an extra little update to the gradient texture to
// help with synchronization.
glActiveTexture(GL_TEXTURE0 + GRAD_TEXTURE_IDX);
uint32_t nullData = 0;
glTexSubImage2D(GL_TEXTURE_2D,
0,
0,
0,
1,
1,
GL_RGBA,
GL_UNSIGNED_BYTE,
&nullData);
}
m_state->bindProgram(m_colorRampProgram);
glBindFramebuffer(GL_FRAMEBUFFER, m_colorRampFBO);
glViewport(0, 0, kGradTextureWidth, desc.gradDataHeight);
m_state->setPipelineState(gpu::COLOR_ONLY_PIPELINE_STATE);
m_state->bindBuffer(GL_ARRAY_BUFFER,
gl_buffer_id(gradSpanBufferRing()));
m_state->bindVAO(m_colorRampVAO);
GLenum colorAttachment0 = GL_COLOR_ATTACHMENT0;
glInvalidateFramebuffer(GL_FRAMEBUFFER, 1, &colorAttachment0);
for (auto [chunkInstanceCount, chunkBaseInstance] : InstanceChunker(
desc.gradSpanCount,
math::lossless_numeric_cast<uint32_t>(desc.firstGradSpan),
m_capabilities.maxSupportedInstancesPerFlush))
{
glVertexAttribIPointer(
0,
4,
GL_UNSIGNED_INT,
0,
reinterpret_cast<const void*>(chunkBaseInstance *
sizeof(gpu::GradientSpan)));
flushInjector.flushBeforeInstancedDrawIfNeeded(chunkInstanceCount);
glDrawArraysInstanced(GL_TRIANGLE_STRIP,
0,
gpu::GRAD_SPAN_TRI_STRIP_VERTEX_COUNT,
chunkInstanceCount);
}
}
// Tessellate all curves into vertices in the tessellation texture.
if (desc.tessVertexSpanCount > 0)
{
m_state->bindProgram(m_tessellateProgram);
glBindFramebuffer(GL_FRAMEBUFFER, m_tessellateFBO);
glViewport(0, 0, gpu::kTessTextureWidth, desc.tessDataHeight);
m_state->setPipelineState(gpu::COLOR_ONLY_PIPELINE_STATE);
m_state->bindBuffer(GL_ARRAY_BUFFER,
gl_buffer_id(tessSpanBufferRing()));
m_state->bindVAO(m_tessellateVAO);
GLenum colorAttachment0 = GL_COLOR_ATTACHMENT0;
glInvalidateFramebuffer(GL_FRAMEBUFFER, 1, &colorAttachment0);
for (auto [chunkInstanceCount, chunkBaseInstance] :
InstanceChunker(desc.tessVertexSpanCount,
math::lossless_numeric_cast<uint32_t>(
desc.firstTessVertexSpan),
m_capabilities.maxSupportedInstancesPerFlush))
{
size_t tessSpanOffsetInBytes =
chunkBaseInstance * sizeof(gpu::TessVertexSpan);
for (GLuint i = 0; i < 3; ++i)
{
glVertexAttribPointer(i,
4,
GL_FLOAT,
GL_FALSE,
sizeof(TessVertexSpan),
reinterpret_cast<const void*>(
tessSpanOffsetInBytes + i * 4 * 4));
}
glVertexAttribIPointer(
3,
4,
GL_UNSIGNED_INT,
sizeof(TessVertexSpan),
reinterpret_cast<const void*>(tessSpanOffsetInBytes +
offsetof(TessVertexSpan, x0x1)));
flushInjector.flushBeforeInstancedDrawIfNeeded(chunkInstanceCount);
glDrawElementsInstanced(GL_TRIANGLES,
std::size(gpu::kTessSpanIndices),
GL_UNSIGNED_SHORT,
0,
chunkInstanceCount);
}
}
// Render the atlas if we have any offscreen feathers.
if ((desc.atlasFillBatchCount | desc.atlasStrokeBatchCount) != 0)
{
// Finish setting up the atlas render pass and clear the atlas.
m_state->setPipelineState(gpu::COLOR_ONLY_PIPELINE_STATE);
glBindFramebuffer(GL_FRAMEBUFFER, m_atlasRenderFBO);
glViewport(0, 0, desc.atlasContentWidth, desc.atlasContentHeight);
// Since the atlas texture is offscreen, we render with the top at the
// lower memory address, and therefore don't need the typical Y-flip
// that happens with GL rectangles.
m_state->setScissorRaw(0,
0,
desc.atlasContentWidth,
desc.atlasContentHeight);
// Invert the front face for atlas draws because GL is bottom up.
glFrontFace(GL_CCW);
switch (m_atlasRenderType)
{
case AtlasRenderType::r16f:
case AtlasRenderType::r32f:
case AtlasRenderType::rgba8:
{
constexpr GLfloat clearZero4f[4]{};
glClearBufferfv(GL_COLOR, 0, clearZero4f);
break;
}
case AtlasRenderType::r32uiFramebufferFetch:
{
constexpr GLuint clearZero4ui[4]{};
glClearBufferuiv(GL_COLOR, 1, clearZero4ui);
break;
}
case AtlasRenderType::r8PixelLocalStorageEXT:
{
#ifdef RIVE_ANDROID
glEnable(GL_SHADER_PIXEL_LOCAL_STORAGE_EXT);
// EXT_shader_pixel_local_storage doesn't support clearing.
// Render the clear color.
m_state->bindProgram(m_atlasClearProgram);
m_state->bindVAO(m_atlasResolveVAO);
m_state->setCullFace(GL_FRONT);
glDrawArrays(GL_TRIANGLES, 0, 3);
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
{
#ifndef RIVE_ANDROID
glBeginPixelLocalStorageANGLE(
1,
std::array<GLenum, 1>{GL_LOAD_OP_ZERO_ANGLE}.data());
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::r32iAtomicTexture:
{
#ifndef RIVE_WEBGL
constexpr GLint clearZero4i[4]{};
glClearBufferiv(GL_COLOR, 0, clearZero4i);
glMemoryBarrier(GL_SHADER_IMAGE_ACCESS_BARRIER_BIT |
GL_FRAMEBUFFER_BARRIER_BIT);
m_state->setWriteMasks(false, false, 0);
glBindImageTexture(0,
m_atlasRenderTexture,
0,
GL_FALSE,
0,
GL_READ_WRITE,
GL_R32I);
#else
RIVE_UNREACHABLE();
#endif
break;
}
}
m_state->bindVAO(m_drawVAO);
// Draw the atlas fills.
if (desc.atlasFillBatchCount != 0)
{
m_state->setPipelineState(m_atlasFillPipelineState);
m_state->bindProgram(m_atlasFillProgram);
for (size_t i = 0; i < desc.atlasFillBatchCount; ++i)
{
const gpu::AtlasDrawBatch& fillBatch = desc.atlasFillBatches[i];
m_state->setScissorRaw(fillBatch.scissor.left,
fillBatch.scissor.top,
fillBatch.scissor.width(),
fillBatch.scissor.height());
drawIndexedInstancedNoInstancedAttribs(
GL_TRIANGLES,
gpu::kMidpointFanCenterAAPatchIndexCount,
gpu::kMidpointFanCenterAAPatchBaseIndex,
fillBatch.patchCount,
fillBatch.basePatch,
m_atlasFillProgram.baseInstanceUniformLocation(),
&flushInjector);
}
}
// Draw the atlas strokes.
if (desc.atlasStrokeBatchCount != 0)
{
m_state->setPipelineState(m_atlasStrokePipelineState);
m_state->bindProgram(m_atlasStrokeProgram);
for (size_t i = 0; i < desc.atlasStrokeBatchCount; ++i)
{
const gpu::AtlasDrawBatch& strokeBatch =
desc.atlasStrokeBatches[i];
m_state->setScissorRaw(strokeBatch.scissor.left,
strokeBatch.scissor.top,
strokeBatch.scissor.width(),
strokeBatch.scissor.height());
drawIndexedInstancedNoInstancedAttribs(
GL_TRIANGLES,
gpu::kMidpointFanPatchBorderIndexCount,
gpu::kMidpointFanPatchBaseIndex,
strokeBatch.patchCount,
strokeBatch.basePatch,
m_atlasStrokeProgram.baseInstanceUniformLocation(),
&flushInjector);
}
}
if (m_atlasResolveProgram != 0)
{
// We need an additional fullscreen draw to resolve the atlas
// into a GL_R8 texture that can be sampled.
if (m_atlasRenderType == AtlasRenderType::r32iAtomicTexture)
{
#ifndef RIVE_WEBGL
glMemoryBarrier(GL_SHADER_IMAGE_ACCESS_BARRIER_BIT);
#else
RIVE_UNREACHABLE();
#endif
}
if (m_atlasResolveFBO != 0)
{
glBindFramebuffer(GL_FRAMEBUFFER, m_atlasResolveFBO);
}
if (m_atlasRenderType == AtlasRenderType::rgba8)
{
// The "rgba8" resolve shader reads the coverageCount data via
// texelFetch().
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, m_atlasRenderTexture);
}
m_state->bindProgram(m_atlasResolveProgram);
m_state->bindVAO(m_atlasResolveVAO);
m_state->setCullFace(GL_NONE);
m_state->setScissorRaw(0,
0,
desc.atlasContentWidth,
desc.atlasContentHeight);
m_state->disableBlending();
m_state->setWriteMasks(true, false, 0);
glDrawArrays(GL_TRIANGLES, 0, 3);
}
// Finalize the atlas render pass if needed.
switch (m_atlasRenderType)
{
case AtlasRenderType::r16f:
case AtlasRenderType::r32f:
{
// If there is no m_atlasResolveFBO, it means we will sample
// directly from the (GL_R16F) atlas texture without resolving
// to GL_R8.
if (m_atlasResolveFBO != 0)
{
// Otherwise, blit m_atlasRenderTexture into the (GL_R8)
// m_atlasTexture.
glBindFramebuffer(GL_DRAW_FRAMEBUFFER, m_atlasResolveFBO);
m_state->disableScissor();
glBlitFramebuffer(0,
0,
desc.atlasContentWidth,
desc.atlasContentHeight,
0,
0,
desc.atlasContentWidth,
desc.atlasContentHeight,
GL_COLOR_BUFFER_BIT,
GL_NEAREST);
}
break;
}
case AtlasRenderType::r32uiFramebufferFetch:
{
// Let the tiler know it can discard the GL_R32UI coverageCount
// attachment now that we've resolved it to GL_R8.
glInvalidateFramebuffer(
GL_FRAMEBUFFER,
1,
std::array<GLenum, 1>{GL_COLOR_ATTACHMENT0}.data());
break;
}
case AtlasRenderType::r8PixelLocalStorageEXT:
{
#ifdef RIVE_ANDROID
glDisable(GL_SHADER_PIXEL_LOCAL_STORAGE_EXT);
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::r32uiPixelLocalStorageANGLE:
{
#ifndef RIVE_ANDROID
// Discard PLS now that we've resolved it to GL_R8.
glEndPixelLocalStorageANGLE(
1,
std::array<GLenum, 1>{GL_DONT_CARE}.data());
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::r32iAtomicTexture:
{
#ifndef RIVE_WEBGL
glMemoryBarrier(GL_SHADER_IMAGE_ACCESS_BARRIER_BIT |
GL_FRAMEBUFFER_BARRIER_BIT);
#else
RIVE_UNREACHABLE();
#endif
break;
}
case AtlasRenderType::rgba8:
{
break;
}
}
glFrontFace(GL_CW);
}
// Bind the currently-submitted buffer in the triangleBufferRing to its
// vertex array.
if (desc.hasTriangleVertices)
{
m_state->bindVAO(m_trianglesVAO);
m_state->bindBuffer(GL_ARRAY_BUFFER,
gl_buffer_id(triangleBufferRing()));
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 0, nullptr);
}
glViewport(0, 0, renderTarget->width(), renderTarget->height());
#ifdef RIVE_DESKTOP_GL
if (m_capabilities.ANGLE_polygon_mode && desc.wireframe)
{
glPolygonModeANGLE(GL_FRONT_AND_BACK, GL_LINE_ANGLE);
glLineWidth(2);
}
#endif
auto msaaResolveAction = RenderTargetGL::MSAAResolveAction::automatic;
std::array<GLenum, 3> msaaDepthStencilColor;
if (desc.interlockMode != gpu::InterlockMode::msaa)
{
assert(desc.msaaSampleCount == 0);
assert(m_plsImpl != nullptr);
m_plsImpl->activatePixelLocalStorage(this, desc);
if (desc.interlockMode == gpu::InterlockMode::atomics)
{
m_plsImpl->ensureRasterOrderingEnabled(this, desc, false);
}
}
else
{
assert(desc.msaaSampleCount > 0);
bool preserveRenderTarget =
desc.colorLoadAction == gpu::LoadAction::preserveRenderTarget;
bool isFBO0;
msaaResolveAction = renderTarget->bindMSAAFramebuffer(
this,
desc.msaaSampleCount,
preserveRenderTarget ? &desc.renderTargetUpdateBounds : nullptr,
&isFBO0);
// Hint to tilers to not load unnecessary buffers from memory.
if (isFBO0)
{
msaaDepthStencilColor = {GL_DEPTH, GL_STENCIL, GL_COLOR};
}
else
{
msaaDepthStencilColor = {GL_DEPTH_ATTACHMENT,
GL_STENCIL_ATTACHMENT,
GL_COLOR_ATTACHMENT0};
}
glInvalidateFramebuffer(GL_FRAMEBUFFER,
preserveRenderTarget ? 2 : 3,
msaaDepthStencilColor.data());
GLbitfield buffersToClear = GL_STENCIL_BUFFER_BIT | GL_DEPTH_BUFFER_BIT;
if (desc.colorLoadAction == gpu::LoadAction::clear)
{
float cc[4];
UnpackColorToRGBA32FPremul(desc.colorClearValue, cc);
glClearColor(cc[0], cc[1], cc[2], cc[3]);
buffersToClear |= GL_COLOR_BUFFER_BIT;
}
m_state->setPipelineState(gpu::GL_DEFAULT_PIPELINE_STATE);
glClear(buffersToClear);
if (enums::is_flag_set(desc.combinedShaderFeatures,
gpu::ShaderFeatures::ENABLE_ADVANCED_BLEND))
{
if (m_capabilities.KHR_blend_equation_advanced_coherent)
{
glEnable(GL_BLEND_ADVANCED_COHERENT_KHR);
}
else
{
// Bind the dstColorTexture where it can be read for in-shader
// blending. We will resolve MSAA into this texture before
// issuing draws that use advanced blend.
// NOTE: The dstColorTexture() function may lazily allocate the
// texture, so don't call glActiveTexture() until it returns.
GLuint dstColorTexture = renderTarget->dstColorTexture();
glActiveTexture(GL_TEXTURE0 + DST_COLOR_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, dstColorTexture);
}
}
}
bool clipPlanesEnabled = false;
// Execute the DrawList.
for (const DrawBatch& batch : *desc.drawList)
{
const gpu::DrawType drawType = batch.drawType;
gpu::ShaderFeatures shaderFeatures =
desc.interlockMode == gpu::InterlockMode::atomics
? desc.combinedShaderFeatures
: batch.shaderFeatures;
gpu::ShaderMiscFlags shaderMiscFlags = batch.shaderMiscFlags;
if (desc.interlockMode != gpu::InterlockMode::msaa)
{
assert(m_plsImpl != nullptr);
shaderMiscFlags |= m_plsImpl->shaderMiscFlags(desc, drawType);
}
const DrawProgram* drawProgram = m_pipelineManager.tryGetPipeline(
{
.drawType = drawType,
.shaderFeatures = shaderFeatures,
.interlockMode = desc.interlockMode,
.shaderMiscFlags = shaderMiscFlags,
#ifdef WITH_RIVE_TOOLS
.synthesizedFailureType = desc.synthesizedFailureType,
#endif
},
m_platformFeatures);
if (drawProgram == nullptr)
{
// There was an issue getting either the requested draw program or
// its ubershader counterpart so we cannot draw anything.
continue;
}
m_state->bindProgram(drawProgram->id());
if (auto imageTextureGL =
static_cast<const TextureGLImpl*>(batch.imageTexture))
{
glActiveTexture(GL_TEXTURE0 + IMAGE_TEXTURE_IDX);
glBindTexture(GL_TEXTURE_2D, *imageTextureGL);
glutils::SetTexture2DSamplingParams(batch.imageSampler);
}
gpu::PipelineState pipelineState;
gpu::get_pipeline_state(batch,
desc,
m_platformFeatures,
&pipelineState);
if (desc.interlockMode != gpu::InterlockMode::msaa)
{
assert(m_plsImpl != nullptr);
m_plsImpl->applyPipelineStateOverrides(batch,
desc,
m_platformFeatures,
&pipelineState);
}
else
{
// Set up the next clipRect.
bool needsClipPlanes =
enums::is_flag_set(shaderFeatures,
gpu::ShaderFeatures::ENABLE_CLIP_RECT);
if (needsClipPlanes != clipPlanesEnabled)
{
auto toggleEnableOrDisable =
needsClipPlanes ? glEnable : glDisable;
toggleEnableOrDisable(GL_CLIP_DISTANCE0_EXT);
toggleEnableOrDisable(GL_CLIP_DISTANCE1_EXT);
toggleEnableOrDisable(GL_CLIP_DISTANCE2_EXT);
toggleEnableOrDisable(GL_CLIP_DISTANCE3_EXT);
clipPlanesEnabled = needsClipPlanes;
}
}
m_state->setPipelineState(pipelineState);
if (enums::any_flag_set(batch.barriers,
BarrierFlags::plsAtomic |
BarrierFlags::plsAtomicPreResolve))
{
assert(desc.interlockMode == gpu::InterlockMode::atomics);
m_plsImpl->barrier(desc);
}
else if (enums::is_flag_set(batch.barriers, BarrierFlags::dstBlend))
{
assert(!m_capabilities.KHR_blend_equation_advanced_coherent);
if (m_capabilities.KHR_blend_equation_advanced)
{
glBlendBarrierKHR();
}
else
{
// Read back the framebuffer where we need a dstColor for
// blending.
assert(desc.interlockMode == gpu::InterlockMode::msaa);
assert(batch.dstReadList != nullptr);
renderTarget->bindDstColorFramebuffer(GL_DRAW_FRAMEBUFFER);
for (const Draw* draw = batch.dstReadList; draw != nullptr;
draw = draw->nextDstRead())
{
assert(draw->blendMode() != BlendMode::srcOver);
glutils::BlitFramebuffer(
desc.renderTargetUpdateBounds.intersect(
draw->pixelBounds()),
renderTarget->height());
}
renderTarget->bindMSAAFramebuffer(this, desc.msaaSampleCount);
}
}
switch (drawType)
{
case DrawType::midpointFanPatches:
case DrawType::midpointFanCenterAAPatches:
case DrawType::outerCurvePatches:
case DrawType::msaaStrokes:
case DrawType::msaaMidpointFanBorrowedCoverage:
case DrawType::msaaMidpointFans:
case DrawType::msaaMidpointFanStencilReset:
case DrawType::msaaMidpointFanPathsStencil:
case DrawType::msaaMidpointFanPathsCover:
case DrawType::msaaOuterCubics:
{
m_state->bindVAO(m_drawVAO);
if (desc.interlockMode == gpu::InterlockMode::rasterOrdering)
{
m_plsImpl->ensureRasterOrderingEnabled(this, desc, true);
}
drawIndexedInstancedNoInstancedAttribs(
GL_TRIANGLES,
gpu::PatchIndexCount(drawType),
gpu::PatchBaseIndex(drawType),
batch.elementCount,
batch.baseElement,
drawProgram->baseInstanceUniformLocation(),
&flushInjector);
break;
}
case gpu::DrawType::clipReset:
{
m_state->bindVAO(m_trianglesVAO);
glDrawArrays(GL_TRIANGLES,
batch.baseElement,
batch.elementCount);
break;
}
case gpu::DrawType::interiorTriangulation:
case gpu::DrawType::atlasBlit:
{
m_state->bindVAO(m_trianglesVAO);
if (desc.interlockMode == gpu::InterlockMode::rasterOrdering)
{
// Disable raster ordering if we're drawing true interior
// triangles (not atlas coverage). We know the triangulation
// is large enough that it's faster to issue a barrier than
// to force raster ordering in the fragment shader.
m_plsImpl->ensureRasterOrderingEnabled(
this,
desc,
drawType != gpu::DrawType::interiorTriangulation);
}
glDrawArrays(GL_TRIANGLES,
batch.baseElement,
batch.elementCount);
if (desc.interlockMode == gpu::InterlockMode::rasterOrdering &&
drawType != gpu::DrawType::atlasBlit)
{
// We turned off raster ordering even though we're in
// "rasterOrdering" mode because it improves performance and
// we know the interior triangles don't overlap. But now we
// have to insert a barrier before we draw anything else.
m_plsImpl->barrier(desc);
}
break;
}
case gpu::DrawType::imageRect:
{
// m_imageRectVAO should have gotten lazily allocated by now.
assert(desc.interlockMode == gpu::InterlockMode::atomics);
assert(m_plsImpl->rasterOrderingKnownDisabled());
assert(m_imageRectVAO != 0);
m_state->bindVAO(m_imageRectVAO);
glBindBufferRange(GL_UNIFORM_BUFFER,
IMAGE_DRAW_UNIFORM_BUFFER_IDX,
gl_buffer_id(imageDrawUniformBufferRing()),
batch.imageDrawDataOffset,
sizeof(gpu::ImageDrawUniforms));
glDrawElements(GL_TRIANGLES,
std::size(gpu::kImageRectIndices),
GL_UNSIGNED_SHORT,
nullptr);
break;
}
case gpu::DrawType::imageMesh:
{
LITE_RTTI_CAST_OR_BREAK(vertexBuffer,
RenderBufferGLImpl*,
batch.vertexBuffer);
LITE_RTTI_CAST_OR_BREAK(uvBuffer,
RenderBufferGLImpl*,
batch.uvBuffer);
LITE_RTTI_CAST_OR_BREAK(indexBuffer,
RenderBufferGLImpl*,
batch.indexBuffer);
m_state->bindVAO(m_imageMeshVAO);
m_state->bindBuffer(GL_ARRAY_BUFFER, vertexBuffer->bufferID());
glVertexAttribPointer(0, 2, GL_FLOAT, GL_FALSE, 0, nullptr);
m_state->bindBuffer(GL_ARRAY_BUFFER, uvBuffer->bufferID());
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 0, nullptr);
m_state->bindBuffer(GL_ELEMENT_ARRAY_BUFFER,
indexBuffer->bufferID());
glBindBufferRange(GL_UNIFORM_BUFFER,
IMAGE_DRAW_UNIFORM_BUFFER_IDX,
gl_buffer_id(imageDrawUniformBufferRing()),
batch.imageDrawDataOffset,
sizeof(gpu::ImageDrawUniforms));
if (desc.interlockMode == gpu::InterlockMode::rasterOrdering)
{
m_plsImpl->ensureRasterOrderingEnabled(this, desc, true);
}
glDrawElements(GL_TRIANGLES,
batch.elementCount,
GL_UNSIGNED_SHORT,
reinterpret_cast<const void*>(batch.baseElement *
sizeof(uint16_t)));
break;
}
case gpu::DrawType::renderPassResolve:
{
assert(desc.interlockMode == gpu::InterlockMode::atomics);
assert(m_plsImpl->rasterOrderingKnownDisabled());
m_state->bindVAO(m_emptyVAO);
glDrawArrays(GL_TRIANGLE_STRIP, 0, 4);
break;
}
case gpu::DrawType::renderPassInitialize:
{
RIVE_UNREACHABLE();
}
}
}
if (desc.interlockMode != gpu::InterlockMode::msaa)
{
m_plsImpl->deactivatePixelLocalStorage(this, desc);
}
else
{
// Depth/stencil can be discarded.
glInvalidateFramebuffer(GL_FRAMEBUFFER,
2,
msaaDepthStencilColor.data());
if (msaaResolveAction ==
RenderTargetGL::MSAAResolveAction::framebufferBlit)
{
renderTarget->bindDestinationFramebuffer(GL_DRAW_FRAMEBUFFER);
m_state->setPipelineState(gpu::COLOR_ONLY_PIPELINE_STATE);
glutils::BlitFramebuffer(desc.renderTargetUpdateBounds,
renderTarget->height(),
GL_COLOR_BUFFER_BIT);
// Now that color is resolved elsewhere we can discard the MSAA
// color buffer as well.
glInvalidateFramebuffer(GL_READ_FRAMEBUFFER,
1,
msaaDepthStencilColor.data() + 2);
}
if (enums::is_flag_set(desc.combinedShaderFeatures,
gpu::ShaderFeatures::ENABLE_ADVANCED_BLEND) &&
m_capabilities.KHR_blend_equation_advanced_coherent)
{
glDisable(GL_BLEND_ADVANCED_COHERENT_KHR);
}
if (clipPlanesEnabled)
{
glDisable(GL_CLIP_DISTANCE0_EXT);
glDisable(GL_CLIP_DISTANCE1_EXT);
glDisable(GL_CLIP_DISTANCE2_EXT);
glDisable(GL_CLIP_DISTANCE3_EXT);
}
}
#ifdef RIVE_DESKTOP_GL
if (m_capabilities.ANGLE_polygon_mode && desc.wireframe)
{
glPolygonModeANGLE(GL_FRONT_AND_BACK, GL_FILL_ANGLE);
}
#endif
// Various Android vendors experience synchronization issues with multiple
// flushes per frame if we don't call glFlush in between.
glFlush();
#ifndef RIVE_WEBGL
// ARM Mali-G78 also needs a memory barrier sometimes to ensure a resolve of
// EXT_multisampled_render_to_texture. (Note that the spec says these
// resolves should all be implicit and automatic.)
//
// ALSO NOTE: We only do this barrier on Mali because the barrier actually
// introduces corruption on Xiaomi Redmi Note 8 (Qualcomm Adreno 610).
if (m_capabilities.isMali && m_capabilities.isGLES &&
m_capabilities.isContextVersionAtLeast(3, 1))
{
glMemoryBarrier(GL_ALL_BARRIER_BITS);
}
#endif
#ifdef RIVE_CANVAS
// Imported canvas mirror sync. If the render target we just flushed
// is a Rive 2D RenderCanvas that some Ore consumer has imported as
// a sampled texture, run a Y-flip blit into the consumer's mirror
// texture now (while GL state is clean). The lookup is an O(1) hash
// miss for non-canvas targets and for canvas targets without active
// consumers — pure pay-for-what-you-use.
blitMirrorIfRegistered(renderTarget->renderTexture());
#endif
}
void RenderContextGLImpl::drawIndexedInstancedNoInstancedAttribs(
GLenum primitiveTopology,
uint32_t indexCount,
uint32_t baseIndex,
uint32_t instanceCount,
uint32_t baseInstance,
GLint baseInstanceUniformLocation,
GLFlushInjector* flushInjector)
{
assert(m_capabilities.ANGLE_base_vertex_base_instance_shader_builtin ==
(baseInstanceUniformLocation < 0));
const void* indexOffset =
reinterpret_cast<const void*>(baseIndex * sizeof(uint16_t));
for (auto [chunkInstanceCount, chunkBaseInstance] :
InstanceChunker(instanceCount,
baseInstance,
m_capabilities.maxSupportedInstancesPerFlush))
{
flushInjector->flushBeforeInstancedDrawIfNeeded(chunkInstanceCount);
#ifndef RIVE_WEBGL
if (m_capabilities.ANGLE_base_vertex_base_instance_shader_builtin)
{
glDrawElementsInstancedBaseInstanceEXT(primitiveTopology,
indexCount,
GL_UNSIGNED_SHORT,
indexOffset,
chunkInstanceCount,
chunkBaseInstance);
}
else
#endif
{
glUniform1i(baseInstanceUniformLocation, chunkBaseInstance);
glDrawElementsInstanced(primitiveTopology,
indexCount,
GL_UNSIGNED_SHORT,
indexOffset,
chunkInstanceCount);
}
}
}
void RenderContextGLImpl::blitTextureToFramebufferAsDraw(
GLuint textureID,
const IAABB& bounds,
uint32_t renderTargetHeight)
{
if (m_blitAsDrawProgram == 0)
{
const char* blitSources[] = {glsl::constants,
glsl::flush_uniforms,
glsl::common,
glsl::blit_texture_as_draw};
m_blitAsDrawProgram = glutils::Program();
m_blitAsDrawProgram.compileAndAttachShader(GL_VERTEX_SHADER,
nullptr,
0,
blitSources,
std::size(blitSources),
m_capabilities);
m_blitAsDrawProgram.compileAndAttachShader(GL_FRAGMENT_SHADER,
nullptr,
0,
blitSources,
std::size(blitSources),
m_capabilities);
m_blitAsDrawProgram.link();
m_state->bindProgram(m_blitAsDrawProgram);
glutils::Uniform1iByName(m_blitAsDrawProgram, GLSL_sourceTexture, 0);
}
m_state->setPipelineState(gpu::COLOR_ONLY_PIPELINE_STATE);
m_state->setScissor(bounds, renderTargetHeight);
m_state->bindProgram(m_blitAsDrawProgram);
m_state->bindVAO(m_emptyVAO);
glActiveTexture(GL_TEXTURE0);
glBindTexture(GL_TEXTURE_2D, textureID);
glDrawArrays(GL_TRIANGLE_STRIP, 0, 4);
}
#ifdef WITH_RIVE_TOOLS
RenderContextGLImpl::AtlasRenderType RenderContextGLImpl::
testingOnly_resetAtlasDesiredRenderType(
RenderContext* owningRenderContext,
AtlasRenderType atlasDesiredRenderType)
{
owningRenderContext->releaseResources();
// Should be cleared by releaseResources().
assert(m_atlasRenderTexture == 0);
assert(m_atlasTexture == 0);
assert(m_atlasRenderFBO == 0);
assert(m_atlasResolveFBO == 0);
// Now release the atlas pipelines so they can be recompiled for the new
// AtlasRenderType.
m_atlasVertexShader = {};
m_atlasFillProgram = {};
m_atlasStrokeProgram = {};
m_atlasResolveVertexShader = {};
m_atlasClearProgram = glutils::Program::Zero();
m_atlasResolveProgram = glutils::Program::Zero();
// ...And release all the DrawShaders in case any need to be recompiled for
// sampling a different AtlasRenderType.
m_pipelineManager.clearCache();
return std::exchange(
m_atlasRenderType,
select_atlas_render_type(m_capabilities, atlasDesiredRenderType));
}
bool RenderContextGLImpl::testingOnly_setBlendAdvancedCoherentKHRSupported(
bool supported)
{
bool wasSupported = m_capabilities.KHR_blend_equation_advanced_coherent;
assert(wasSupported == m_platformFeatures.supportsBlendAdvancedCoherentKHR);
m_capabilities.KHR_blend_equation_advanced_coherent = supported;
m_platformFeatures.supportsBlendAdvancedCoherentKHR = supported;
// Clear the shader cache since these are built with hard expectations about
// m_capabilities/m_platformFeatures.
m_pipelineManager.clearCache();
return wasSupported;
}
bool RenderContextGLImpl::testingOnly_setBlendAdvancedKHRSupported(
bool supported)
{
bool wasSupported = m_capabilities.KHR_blend_equation_advanced;
assert(wasSupported == m_platformFeatures.supportsBlendAdvancedKHR);
m_capabilities.KHR_blend_equation_advanced = supported;
m_platformFeatures.supportsBlendAdvancedKHR = supported;
// Clear the shader cache since these are built with hard expectations about
// m_capabilities/m_platformFeatures.
m_pipelineManager.clearCache();
return wasSupported;
}
#endif
#ifdef _MSC_VER
#define SSCANF sscanf_s
#else
#define SSCANF sscanf
#endif
std::unique_ptr<RenderContext> RenderContextGLImpl::MakeContext(
const ContextOptions& contextOptions)
{
const char* glVersionStr = (const char*)glGetString(GL_VERSION);
GLenum rendererToken = GL_RENDERER;
#ifdef RIVE_WEBGL
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"WEBGL_debug_renderer_info"))
{
rendererToken = GL_UNMASKED_RENDERER_WEBGL;
}
#endif
const char* rendererString =
reinterpret_cast<const char*>(glGetString(rendererToken));
GLCapabilities capabilities{};
#ifdef RIVE_WEBGL
capabilities.isGLES = true;
// If GL_UNMASKED_RENDERER_WEBGL says "ANGLE", that means we are running on
// an ANGLE system driver. e.g.:
//
// WebGL (probably ANGLE) -> System OpenGL ES (also ANGLE) -> Vulkan
//
capabilities.isANGLESystemDriver =
strstr(rendererString, "ANGLE") != nullptr;
#else
capabilities.isGLES = strstr(glVersionStr, "OpenGL ES") != nullptr;
capabilities.isANGLESystemDriver =
strstr(glVersionStr, "ANGLE") != nullptr ||
strstr(rendererString, "ANGLE") != nullptr;
#endif
capabilities.isAdreno = strstr(rendererString, "Adreno");
capabilities.isMali = strstr(rendererString, "Mali");
capabilities.isPowerVR = strstr(rendererString, "PowerVR");
if (!capabilities.isGLES)
{
SSCANF(glVersionStr,
"%u.%u",
&capabilities.contextVersionMajor,
&capabilities.contextVersionMinor);
capabilities.vendorDriverVersionMajor = 0;
capabilities.vendorDriverVersionMinor = 0;
}
else if (capabilities.isPowerVR)
{
SSCANF(glVersionStr,
"OpenGL ES %u.%u build %u.%u@",
&capabilities.contextVersionMajor,
&capabilities.contextVersionMinor,
&capabilities.vendorDriverVersionMajor,
&capabilities.vendorDriverVersionMinor);
}
else
{
SSCANF(glVersionStr,
"OpenGL ES %u.%u",
&capabilities.contextVersionMajor,
&capabilities.contextVersionMinor);
capabilities.vendorDriverVersionMajor = 0;
capabilities.vendorDriverVersionMinor = 0;
}
#ifdef RIVE_DESKTOP_GL
assert(capabilities.contextVersionMajor == GLAD_GL_version_major);
assert(capabilities.contextVersionMinor == GLAD_GL_version_minor);
assert(capabilities.isGLES == static_cast<bool>(GLAD_GL_version_es));
#endif
if (!capabilities.isAdreno ||
!sscanf(rendererString, "Adreno (TM) %d", &capabilities.adrenoSeries))
{
capabilities.adrenoSeries = 0;
}
if (capabilities.isGLES)
{
if (!capabilities.isContextVersionAtLeast(3, 0))
{
fprintf(stderr,
"OpenGL ES %i.%i not supported. Minimum supported version "
"is 3.0.\n",
capabilities.contextVersionMajor,
capabilities.contextVersionMinor);
return nullptr;
}
}
else
{
if (!capabilities.isContextVersionAtLeast(4, 2))
{
fprintf(stderr,
"OpenGL %i.%i not supported. Minimum supported version is "
"4.2.\n",
capabilities.contextVersionMajor,
capabilities.contextVersionMinor);
return nullptr;
}
}
if (capabilities.isMali || capabilities.isPowerVR ||
(capabilities.isAdreno && capabilities.adrenoSeries < 600))
{
// We have observed crashes on Mali-G71 when issuing instanced draws
// with somewhere between 2^15 and 2^16 instances.
//
// Skia also reports crashes on PowerVR when drawing somewhere between
// 2^14 and 2^15 instances.
//
// We have observed Adreno 308 crash when drawing too many instances
// spread across any number of draw calls. Breaking them up with glFlush
// appears to fix the crashes.
//
// Limit the maximum number of instances we issue per flush on these
// devices, splitting up draw calls if needed.
capabilities.maxSupportedInstancesPerFlush = (1u << 13) - 1u;
}
else
{
capabilities.maxSupportedInstancesPerFlush = ~0u;
}
// Our baseline feature set is GLES 3.0. Capabilities from newer context
// versions are reported as extensions.
if (capabilities.isGLES)
{
// ETC2 is mandatory in GLES 3.0+.
capabilities.supportsETC2 = true;
if (capabilities.isContextVersionAtLeast(3, 1))
{
capabilities.ARB_shader_storage_buffer_object = true;
}
if (capabilities.isContextVersionAtLeast(3, 2))
{
capabilities.OES_shader_image_atomic = true;
}
}
else
{
if (capabilities.isContextVersionAtLeast(4, 2))
{
capabilities.ARB_shader_image_load_store = true;
}
if (capabilities.isContextVersionAtLeast(4, 3))
{
capabilities.ARB_shader_storage_buffer_object = true;
}
capabilities.EXT_clip_cull_distance = true;
}
#ifndef RIVE_WEBGL
GLint extensionCount;
glGetIntegerv(GL_NUM_EXTENSIONS, &extensionCount);
for (int i = 0; i < extensionCount; ++i)
{
auto* ext =
reinterpret_cast<const char*>(glGetStringi(GL_EXTENSIONS, i));
if (strcmp(ext, "GL_ANGLE_base_vertex_base_instance_shader_builtin") ==
0)
{
capabilities.ANGLE_base_vertex_base_instance_shader_builtin = true;
}
else if (strcmp(ext, "GL_ANGLE_shader_pixel_local_storage") == 0)
{
#ifndef RIVE_ANDROID
capabilities.ANGLE_shader_pixel_local_storage = true;
#endif
}
else if (strcmp(ext, "GL_ANGLE_shader_pixel_local_storage_coherent") ==
0)
{
#ifndef RIVE_ANDROID
capabilities.ANGLE_shader_pixel_local_storage_coherent = true;
#endif
}
else if (strcmp(ext, "GL_ANGLE_provoking_vertex") == 0)
{
capabilities.ANGLE_provoking_vertex = true;
}
else if (strcmp(ext, "GL_ANGLE_polygon_mode") == 0)
{
capabilities.ANGLE_polygon_mode = true;
}
else if (strcmp(ext, "GL_ARM_shader_framebuffer_fetch") == 0)
{
capabilities.ARM_shader_framebuffer_fetch = true;
}
else if (strcmp(ext, "GL_ARB_fragment_shader_interlock") == 0)
{
capabilities.ARB_fragment_shader_interlock = true;
}
else if (strcmp(ext, "GL_ARB_shader_image_load_store") == 0)
{
capabilities.ARB_shader_image_load_store = true;
}
else if (strcmp(ext, "GL_ARB_shader_storage_buffer_object") == 0)
{
capabilities.ARB_shader_storage_buffer_object = true;
}
else if (strcmp(ext, "GL_OES_shader_image_atomic") == 0)
{
capabilities.OES_shader_image_atomic = true;
}
else if (strcmp(ext, "GL_KHR_blend_equation_advanced") == 0)
{
capabilities.KHR_blend_equation_advanced = true;
}
else if (strcmp(ext, "GL_KHR_blend_equation_advanced_coherent") == 0)
{
capabilities.KHR_blend_equation_advanced_coherent = true;
}
else if (strcmp(ext, "GL_KHR_parallel_shader_compile") == 0)
{
capabilities.KHR_parallel_shader_compile = true;
}
else if (strcmp(ext, "GL_EXT_base_instance") == 0)
{
capabilities.EXT_base_instance = true;
}
else if (strcmp(ext, "GL_EXT_clip_cull_distance") == 0 ||
strcmp(ext, "GL_ANGLE_clip_cull_distance") == 0)
{
capabilities.EXT_clip_cull_distance = true;
}
else if (strcmp(ext, "GL_EXT_multisampled_render_to_texture") == 0)
{
capabilities.EXT_multisampled_render_to_texture = true;
}
else if (strcmp(ext, "GL_INTEL_fragment_shader_ordering") == 0)
{
capabilities.INTEL_fragment_shader_ordering = true;
}
else if (strcmp(ext, "GL_EXT_color_buffer_half_float") == 0)
{
capabilities.EXT_color_buffer_half_float = true;
}
else if (strcmp(ext, "GL_OES_texture_half_float_linear") == 0)
{
capabilities.OES_texture_half_float_linear = true;
}
else if (strcmp(ext, "GL_EXT_color_buffer_float") == 0)
{
capabilities.EXT_color_buffer_float = true;
}
else if (strcmp(ext, "GL_EXT_float_blend") == 0)
{
capabilities.EXT_float_blend = true;
}
else if (strcmp(ext, "GL_ARB_color_buffer_float") == 0)
{
capabilities.EXT_color_buffer_half_float = true;
capabilities.EXT_color_buffer_float = true;
capabilities.EXT_float_blend = true;
}
else if (strcmp(ext, "GL_EXT_shader_framebuffer_fetch") == 0)
{
capabilities.EXT_shader_framebuffer_fetch = true;
}
else if (strcmp(ext, "GL_EXT_shader_pixel_local_storage") == 0)
{
capabilities.EXT_shader_pixel_local_storage = true;
}
else if (strcmp(ext, "GL_EXT_shader_pixel_local_storage2") == 0)
{
capabilities.EXT_shader_pixel_local_storage2 = true;
}
else if (strcmp(ext, "GL_QCOM_shader_framebuffer_fetch_noncoherent") ==
0)
{
capabilities.QCOM_shader_framebuffer_fetch_noncoherent = true;
}
else if (strcmp(ext, "GL_EXT_texture_compression_s3tc") == 0)
{
capabilities.EXT_texture_compression_s3tc = true;
}
else if (strcmp(ext, "GL_EXT_texture_compression_bptc") == 0 ||
strcmp(ext, "GL_ARB_texture_compression_bptc") == 0)
{
capabilities.EXT_texture_compression_bptc = true;
}
else if (strcmp(ext, "GL_KHR_texture_compression_astc_ldr") == 0)
{
capabilities.KHR_texture_compression_astc_ldr = true;
}
else if (strcmp(ext, "GL_ARB_ES3_compatibility") == 0)
{
// Desktop GL exposes ETC2 via this extension.
capabilities.supportsETC2 = true;
}
}
#ifdef RIVE_DESKTOP_GL
if (GLAD_GL_ANGLE_base_vertex_base_instance_shader_builtin)
{
capabilities.ANGLE_base_vertex_base_instance_shader_builtin = true;
}
if (GLAD_GL_ANGLE_polygon_mode)
{
capabilities.ANGLE_polygon_mode = true;
}
if (GLAD_GL_EXT_base_instance)
{
capabilities.EXT_base_instance = true;
}
#endif
// OES_texture_half_float_linear is core functionality in ES3. We only treat
// it as an extension because it's gated in WebGL2.
capabilities.OES_texture_half_float_linear = true;
#else // !RIVE_WEBGL -> RIVE_WEBGL
if (webgl_enable_WEBGL_shader_pixel_local_storage_coherent())
{
capabilities.ANGLE_shader_pixel_local_storage = true;
capabilities.ANGLE_shader_pixel_local_storage_coherent = true;
}
if (webgl_enable_WEBGL_provoking_vertex())
{
capabilities.ANGLE_provoking_vertex = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"WEBGL_clip_cull_distance"))
{
capabilities.EXT_clip_cull_distance = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"EXT_color_buffer_half_float"))
{
capabilities.EXT_color_buffer_half_float = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"OES_texture_half_float_linear"))
{
capabilities.OES_texture_half_float_linear = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"EXT_color_buffer_float"))
{
capabilities.EXT_color_buffer_float = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"EXT_float_blend"))
{
capabilities.EXT_float_blend = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"KHR_parallel_shader_compile"))
{
capabilities.KHR_parallel_shader_compile = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"WEBGL_compressed_texture_s3tc"))
{
capabilities.EXT_texture_compression_s3tc = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"EXT_texture_compression_bptc"))
{
capabilities.EXT_texture_compression_bptc = true;
}
if (emscripten_webgl_enable_extension(
emscripten_webgl_get_current_context(),
"WEBGL_compressed_texture_astc"))
{
capabilities.KHR_texture_compression_astc_ldr = true;
}
#endif // RIVE_WEBGL
if (capabilities.ARB_shader_storage_buffer_object)
{
// We need four storage buffers in the vertex shader. Disable the
// extension if this isn't supported.
int maxVertexShaderStorageBlocks;
glGetIntegerv(GL_MAX_VERTEX_SHADER_STORAGE_BLOCKS,
&maxVertexShaderStorageBlocks);
if (maxVertexShaderStorageBlocks < gpu::kMaxStorageBuffers)
{
capabilities.ARB_shader_storage_buffer_object = false;
}
}
if (capabilities.OES_shader_image_atomic)
{
if (capabilities.isMali || capabilities.isPowerVR ||
(capabilities.isAdreno &&
strstr(rendererString, "Adreno (TM) 640") == nullptr))
{
// Don't use image atomics for feathering on Adreno, Mali, or
// PowerVR. On Adreno (specifically 660 & 642L) and PowerVR they
// sometimes just don't render, and on Mali they lead to a failure
// that says:
//
// Error:glDrawElementsInstanced::failed to allocate CPU memory
//
// NOTE: We allow Adreno 640 to use atomics because it works
// reliably on our CI and gives us coverage of this codepath for ES.
//
// Realistically these vendors have better ways to render the
// feather atlas that they will use in real lifeanyway, namely,
// EXT_float_blend, EXT_color_buffer_half_float,
// EXT_shader_framebuffer_fetch, and/or
// EXT_shader_pixel_local_storage.
//
// It's possible we have some barriers wrong, but a fallback this
// deep isn't a priority right now on GL.
capabilities.OES_shader_image_atomic = false;
}
}
if (capabilities.ANGLE_base_vertex_base_instance_shader_builtin)
{
if (capabilities.isANGLESystemDriver)
{
// Disable ANGLE_base_vertex_base_instance_shader_builtin on ANGLE.
// The extension has started crashing.
// (Meaning, now we only use it when we're Desktop GL and pretending
// we have ANGLE_base_vertex_base_instance_shader_builtin, but
// actually just have the functionality by default because it's part
// of Desktop GL.)
capabilities.ANGLE_base_vertex_base_instance_shader_builtin = false;
}
}
if (capabilities.EXT_clip_cull_distance)
{
if (capabilities.isANGLESystemDriver)
{
// Don't use EXT_clip_cull_distance or ANGLE_clip_cull_distance if
// our system GL driver is ANGLE. Various Galaxy devices using ANGLE
// have bugs with these extensions.
capabilities.EXT_clip_cull_distance = false;
}
}
if (capabilities.EXT_multisampled_render_to_texture)
{
if (strstr(rendererString, "Direct3D") != nullptr)
{
// Our use of EXT_multisampled_render_to_texture causes a segfault
// in the Microsoft WARP (software) renderer. Just don't use this
// extension on D3D since it's polyfilled anyway.
capabilities.EXT_multisampled_render_to_texture = false;
}
if (capabilities.isPowerVR &&
!capabilities.isVendorDriverVersionAtLeast(1, 13))
{
// PowerVR Rogue GE8300, OpenGL ES 3.2 build 1.10@5187610 and
// PowerVR Rogue GM9446; OpenGL ES 3.2 build 1.11@5425693 both have
// similar artifacts when using EXT_multisampled_render_to_texture.
// Block the extension before the earliest known good driver, which
// is 1.13.
capabilities.EXT_multisampled_render_to_texture = false;
}
}
if (contextOptions.disableFragmentShaderInterlock)
{
// Disable the extensions we don't want to use internally.
capabilities.ARB_fragment_shader_interlock = false;
capabilities.INTEL_fragment_shader_ordering = false;
}
#ifdef RIVE_ANDROID
// On Android we need to explicitly load the extension functions. This will
// additionally clear the capabilities flags for any extension that could
// not load.
LoadAndValidateGLESExtensions(&capabilities);
#endif
if (strstr(rendererString, "ANGLE Metal Renderer") != nullptr &&
capabilities.EXT_color_buffer_float)
{
capabilities.needsFloatingPointTessellationTexture = true;
}
else
{
capabilities.needsFloatingPointTessellationTexture = false;
}
if (capabilities.EXT_shader_pixel_local_storage2)
{
if (capabilities.isPowerVR &&
!capabilities.isVendorDriverVersionAtLeast(1, 11))
{
// PowerVR Rogue GE8300, OpenGL ES 3.2 build 1.10@5187610 has severe
// pixel local storage corruption issues with our renderer. Using
// some of the EXT_shader_pixel_local_storage2 API is an apparent
// workaround that comes with worse performance and other, less
// severe visual artifacts.
// Require this workaround before the earliest known good driver,
// which is 1.11.
capabilities.usePixelLocalStorage2AsWorkaround = true;
}
}
if (capabilities.ANGLE_shader_pixel_local_storage)
{
if (strstr(rendererString, "Direct3D11") != nullptr)
{
// ANGLE_shader_pixel_local_storage is currently broken with
// GL_TEXTURE_2D_ARRAY on ANGLE's d3d11 renderer.
capabilities.avoidTexture2DArrayWithWebGLPLS = true;
}
}
if (!contextOptions.disablePixelLocalStorage)
{
#ifdef RIVE_ANDROID
if (capabilities.EXT_shader_pixel_local_storage &&
(capabilities.ARM_shader_framebuffer_fetch ||
capabilities.EXT_shader_framebuffer_fetch))
{
// Favor MSAA over pixel local storage on PowerVR due to various
// bugs in its driver, except on PowerVR pre-1.15, where MSAA
// doesn't work.
if (!capabilities.isPowerVR ||
!capabilities.isVendorDriverVersionAtLeast(1, 15))
{
return MakeContext(rendererString,
capabilities,
MakePLSImplEXTNative(capabilities),
contextOptions.shaderCompilationMode);
}
}
#else
if (capabilities.ANGLE_shader_pixel_local_storage_coherent)
{
// EXT_shader_framebuffer_fetch is costly on Qualcomm, with or
// without the "noncoherent" extension. Use MSAA on Adreno.
if (!capabilities.isAdreno)
{
return MakeContext(rendererString,
capabilities,
MakePLSImplWebGL(),
contextOptions.shaderCompilationMode);
}
}
#endif
#ifdef RIVE_DESKTOP_GL
if (capabilities.ARB_shader_image_load_store)
{
return MakeContext(rendererString,
capabilities,
MakePLSImplRWTexture(),
contextOptions.shaderCompilationMode);
}
#endif
}
return MakeContext(rendererString,
capabilities,
nullptr,
contextOptions.shaderCompilationMode);
}
RenderContextGLImpl::GLPipelineManager::GLPipelineManager(
ShaderCompilationMode mode,
RenderContextGLImpl* context) :
Super(mode), m_context(context)
{}
std::unique_ptr<RenderContextGLImpl::DrawProgram> RenderContextGLImpl::
GLPipelineManager::createPipeline(PipelineCreateType createType,
uint32_t, // unused key
const PipelineProps& props,
const PlatformFeatures&)
{
return std::make_unique<DrawProgram>(m_context,
createType,
props.drawType,
props.shaderFeatures,
props.interlockMode,
props.shaderMiscFlags
#ifdef WITH_RIVE_TOOLS
,
props.synthesizedFailureType
#endif
);
}
PipelineStatus RenderContextGLImpl::GLPipelineManager::getPipelineStatus(
const DrawProgram& state) const
{
return state.status();
}
bool RenderContextGLImpl::GLPipelineManager::advanceCreation(
DrawProgram& pipelineState,
const PipelineProps& props)
{
return pipelineState.advanceCreation(m_context,
PipelineCreateType::async,
props.drawType,
props.shaderFeatures,
props.interlockMode,
props.shaderMiscFlags);
}
std::unique_ptr<RenderContextGLImpl::DrawShader> RenderContextGLImpl::
GLPipelineManager::createVertexShader(DrawType drawType,
ShaderFeatures shaderFeatures,
InterlockMode interlockMode)
{
return std::make_unique<DrawShader>(m_context,
GL_VERTEX_SHADER,
drawType,
shaderFeatures,
interlockMode,
ShaderMiscFlags::none);
}
std::unique_ptr<RenderContextGLImpl::DrawShader> RenderContextGLImpl::
GLPipelineManager::createFragmentShader(DrawType drawType,
ShaderFeatures shaderFeatures,
InterlockMode interlockMode,
ShaderMiscFlags miscFlags)
{
return std::make_unique<DrawShader>(m_context,
GL_FRAGMENT_SHADER,
drawType,
shaderFeatures,
interlockMode,
miscFlags);
}
std::unique_ptr<RenderContext> RenderContextGLImpl::MakeContext(
const char* rendererString,
GLCapabilities capabilities,
std::unique_ptr<PixelLocalStorageImpl> plsImpl,
ShaderCompilationMode shaderCompilationMode)
{
auto renderContextImpl = std::unique_ptr<RenderContextGLImpl>(
new RenderContextGLImpl(rendererString,
capabilities,
std::move(plsImpl),
shaderCompilationMode));
return std::make_unique<RenderContext>(std::move(renderContextImpl));
}
} // namespace rive::gpu
#if defined(ORE_BACKEND_GL) && defined(RIVE_CANVAS)
rive::rcp<rive::RiveRenderImage> rive::getCanvasImportMirrorGL(
gpu::RenderContext* renderCtx,
gpu::Texture* sourceTex,
uint32_t width,
uint32_t height)
{
if (renderCtx == nullptr ||
!renderCtx->platformFeatures().framebufferBottomUp)
{
return nullptr;
}
auto* glImpl = renderCtx->static_impl_cast<gpu::RenderContextGLImpl>();
return glImpl->getCanvasImportMirror(sourceTex, width, height);
}
#endif