Hash :
718cdb91
Author :
Date :
2025-09-08T15:32:34
[WebGPU] Set ReadPixels to use context's command encoder. This change modifies ContextWgpu::getCurrentCommandEncoder() such that it now ends a render pass if there's an active one, ensures a command encoder is created, then sets an outHandle command encoder. This streamlines a lot of repetitive calls when getting the command encoder. This change also modifies ImageHelper::readPixels such that it now gets the command encoder from the context instead of making its own. This ensure that when the queue is submitted for a read call, that any draw/clear/etc calls in the queue are also submitted for a texture so that a read call can properly read from the texture. Bug: angleproject:438268609 Change-Id: Iec6d7f7ca27c7640cc8bdb42da53f64e4836dc5a Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/6923328 Reviewed-by: Geoff Lang <geofflang@chromium.org> Commit-Queue: Liza Burakova <liza@chromium.org> Reviewed-by: Matthew Denton <mpdenton@chromium.org>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
//
// Copyright 2024 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// ContextWgpu.h:
// Defines the class interface for ContextWgpu, implementing ContextImpl.
//
#ifndef LIBANGLE_RENDERER_WGPU_CONTEXTWGPU_H_
#define LIBANGLE_RENDERER_WGPU_CONTEXTWGPU_H_
#include <webgpu/webgpu.h>
#include "image_util/loadimage.h"
#include "libANGLE/renderer/ContextImpl.h"
#include "libANGLE/renderer/wgpu/DisplayWgpu.h"
#include "libANGLE/renderer/wgpu/wgpu_command_buffer.h"
#include "libANGLE/renderer/wgpu/wgpu_format_utils.h"
#include "libANGLE/renderer/wgpu/wgpu_helpers.h"
#include "libANGLE/renderer/wgpu/wgpu_pipeline_state.h"
#include "libANGLE/renderer/wgpu/wgpu_utils.h"
namespace rx
{
class ContextWgpu : public ContextImpl
{
private:
// Must keep this in sync with DriverUniform::createUniformFields in:
// src/compiler/translator/tree_util/DriverUniform.cpp
// For shader uniforms such as gl_DepthRange and the viewport size.
//
// Note: this struct was originally for Vulkan, but may be able to be pared down for WGSL.
struct DriverUniforms
{
std::array<uint32_t, 2> acbBufferOffsets;
// .x is near, .y is far
std::array<float, 2> depthRange;
// Used to flip gl_FragCoord. Packed uvec2
uint32_t renderArea;
// Packed vec4 of snorm8
uint32_t flipXY;
// Only the lower 16 bits used
uint32_t dither;
// Various bits of state:
// - Surface rotation
// - Advanced blend equation
// - Sample count
// - Enabled clip planes
// - Depth transformation
// - layered FBO
uint32_t misc;
};
static_assert(sizeof(DriverUniforms) % (sizeof(uint32_t) * 4) == 0,
"DriverUniforms should be 16 bytes aligned");
public:
static constexpr size_t kDriverUniformSize = sizeof(DriverUniforms);
ContextWgpu(const gl::State &state, gl::ErrorSet *errorSet, DisplayWgpu *display);
~ContextWgpu() override;
angle::Result initialize(const angle::ImageLoadContext &imageLoadContext) override;
void onDestroy(const gl::Context *context) override;
// Flush and finish.
angle::Result flush(const gl::Context *context) override;
angle::Result finish(const gl::Context *context) override;
// Drawing methods.
angle::Result drawArrays(const gl::Context *context,
gl::PrimitiveMode mode,
GLint first,
GLsizei count) override;
angle::Result drawArraysInstanced(const gl::Context *context,
gl::PrimitiveMode mode,
GLint first,
GLsizei count,
GLsizei instanceCount) override;
angle::Result drawArraysInstancedBaseInstance(const gl::Context *context,
gl::PrimitiveMode mode,
GLint first,
GLsizei count,
GLsizei instanceCount,
GLuint baseInstance) override;
angle::Result drawElements(const gl::Context *context,
gl::PrimitiveMode mode,
GLsizei count,
gl::DrawElementsType type,
const void *indices) override;
angle::Result drawElementsBaseVertex(const gl::Context *context,
gl::PrimitiveMode mode,
GLsizei count,
gl::DrawElementsType type,
const void *indices,
GLint baseVertex) override;
angle::Result drawElementsInstanced(const gl::Context *context,
gl::PrimitiveMode mode,
GLsizei count,
gl::DrawElementsType type,
const void *indices,
GLsizei instances) override;
angle::Result drawElementsInstancedBaseVertex(const gl::Context *context,
gl::PrimitiveMode mode,
GLsizei count,
gl::DrawElementsType type,
const void *indices,
GLsizei instances,
GLint baseVertex) override;
angle::Result drawElementsInstancedBaseVertexBaseInstance(const gl::Context *context,
gl::PrimitiveMode mode,
GLsizei count,
gl::DrawElementsType type,
const void *indices,
GLsizei instances,
GLint baseVertex,
GLuint baseInstance) override;
angle::Result drawRangeElements(const gl::Context *context,
gl::PrimitiveMode mode,
GLuint start,
GLuint end,
GLsizei count,
gl::DrawElementsType type,
const void *indices) override;
angle::Result drawRangeElementsBaseVertex(const gl::Context *context,
gl::PrimitiveMode mode,
GLuint start,
GLuint end,
GLsizei count,
gl::DrawElementsType type,
const void *indices,
GLint baseVertex) override;
angle::Result drawArraysIndirect(const gl::Context *context,
gl::PrimitiveMode mode,
const void *indirect) override;
angle::Result drawElementsIndirect(const gl::Context *context,
gl::PrimitiveMode mode,
gl::DrawElementsType type,
const void *indirect) override;
angle::Result multiDrawArrays(const gl::Context *context,
gl::PrimitiveMode mode,
const GLint *firsts,
const GLsizei *counts,
GLsizei drawcount) override;
angle::Result multiDrawArraysInstanced(const gl::Context *context,
gl::PrimitiveMode mode,
const GLint *firsts,
const GLsizei *counts,
const GLsizei *instanceCounts,
GLsizei drawcount) override;
angle::Result multiDrawArraysIndirect(const gl::Context *context,
gl::PrimitiveMode mode,
const void *indirect,
GLsizei drawcount,
GLsizei stride) override;
angle::Result multiDrawElements(const gl::Context *context,
gl::PrimitiveMode mode,
const GLsizei *counts,
gl::DrawElementsType type,
const GLvoid *const *indices,
GLsizei drawcount) override;
angle::Result multiDrawElementsInstanced(const gl::Context *context,
gl::PrimitiveMode mode,
const GLsizei *counts,
gl::DrawElementsType type,
const GLvoid *const *indices,
const GLsizei *instanceCounts,
GLsizei drawcount) override;
angle::Result multiDrawElementsIndirect(const gl::Context *context,
gl::PrimitiveMode mode,
gl::DrawElementsType type,
const void *indirect,
GLsizei drawcount,
GLsizei stride) override;
angle::Result multiDrawArraysInstancedBaseInstance(const gl::Context *context,
gl::PrimitiveMode mode,
const GLint *firsts,
const GLsizei *counts,
const GLsizei *instanceCounts,
const GLuint *baseInstances,
GLsizei drawcount) override;
angle::Result multiDrawElementsInstancedBaseVertexBaseInstance(const gl::Context *context,
gl::PrimitiveMode mode,
const GLsizei *counts,
gl::DrawElementsType type,
const GLvoid *const *indices,
const GLsizei *instanceCounts,
const GLint *baseVertices,
const GLuint *baseInstances,
GLsizei drawcount) override;
// Device loss
gl::GraphicsResetStatus getResetStatus() override;
// EXT_debug_marker
angle::Result insertEventMarker(GLsizei length, const char *marker) override;
angle::Result pushGroupMarker(GLsizei length, const char *marker) override;
angle::Result popGroupMarker() override;
// KHR_debug
angle::Result pushDebugGroup(const gl::Context *context,
GLenum source,
GLuint id,
const std::string &message) override;
angle::Result popDebugGroup(const gl::Context *context) override;
// State sync with dirty bits.
angle::Result syncState(const gl::Context *context,
const gl::state::DirtyBits dirtyBits,
const gl::state::DirtyBits bitMask,
const gl::state::ExtendedDirtyBits extendedDirtyBits,
const gl::state::ExtendedDirtyBits extendedBitMask,
gl::Command command) override;
// Disjoint timer queries
GLint getGPUDisjoint() override;
GLint64 getTimestamp() override;
// Context switching
angle::Result onMakeCurrent(const gl::Context *context) override;
// Native capabilities, unmodified by gl::Context.
gl::Caps getNativeCaps() const override;
const gl::TextureCapsMap &getNativeTextureCaps() const override;
const gl::Extensions &getNativeExtensions() const override;
const gl::Limitations &getNativeLimitations() const override;
const ShPixelLocalStorageOptions &getNativePixelLocalStorageOptions() const override;
// Shader creation
CompilerImpl *createCompiler() override;
ShaderImpl *createShader(const gl::ShaderState &data) override;
ProgramImpl *createProgram(const gl::ProgramState &data) override;
ProgramExecutableImpl *createProgramExecutable(
const gl::ProgramExecutable *executable) override;
// Framebuffer creation
FramebufferImpl *createFramebuffer(const gl::FramebufferState &data) override;
// Texture creation
TextureImpl *createTexture(const gl::TextureState &state) override;
// Renderbuffer creation
RenderbufferImpl *createRenderbuffer(const gl::RenderbufferState &state) override;
// Buffer creation
BufferImpl *createBuffer(const gl::BufferState &state) override;
// Vertex Array creation
VertexArrayImpl *createVertexArray(const gl::VertexArrayState &data,
const gl::VertexArrayBuffers &vertexArrayBuffers) override;
// Query and Fence creation
QueryImpl *createQuery(gl::QueryType type) override;
FenceNVImpl *createFenceNV() override;
SyncImpl *createSync() override;
// Transform Feedback creation
TransformFeedbackImpl *createTransformFeedback(
const gl::TransformFeedbackState &state) override;
// Sampler object creation
SamplerImpl *createSampler(const gl::SamplerState &state) override;
// Program Pipeline object creation
ProgramPipelineImpl *createProgramPipeline(const gl::ProgramPipelineState &data) override;
// Memory object creation.
MemoryObjectImpl *createMemoryObject() override;
// Semaphore creation.
SemaphoreImpl *createSemaphore() override;
// Overlay creation.
OverlayImpl *createOverlay(const gl::OverlayState &state) override;
angle::Result dispatchCompute(const gl::Context *context,
GLuint numGroupsX,
GLuint numGroupsY,
GLuint numGroupsZ) override;
angle::Result dispatchComputeIndirect(const gl::Context *context, GLintptr indirect) override;
angle::Result memoryBarrier(const gl::Context *context, GLbitfield barriers) override;
angle::Result memoryBarrierByRegion(const gl::Context *context, GLbitfield barriers) override;
void handleError(GLenum errorCode,
const char *message,
const char *file,
const char *function,
unsigned int line);
const angle::ImageLoadContext &getImageLoadContext() const { return mImageLoadContext; }
DisplayWgpu *getDisplay() const { return mDisplay; }
const angle::FeaturesWgpu &getFeatures() const { return mDisplay->getFeatures(); }
const DawnProcTable *getProcs() const { return mDisplay->getProcs(); }
webgpu::DeviceHandle getDevice() const { return mDisplay->getDevice(); }
webgpu::QueueHandle getQueue() const { return mDisplay->getQueue(); }
webgpu::InstanceHandle getInstance() const { return mDisplay->getInstance(); }
angle::ImageLoadContext &getImageLoadContext() { return mImageLoadContext; }
const webgpu::Format &getFormat(GLenum internalFormat) const
{
return mDisplay->getFormat(internalFormat);
}
angle::Result startRenderPass(const webgpu::PackedRenderPassDescriptor &desc);
angle::Result endRenderPass(webgpu::RenderPassClosureReason closureReason);
bool hasActiveRenderPass() { return mCurrentRenderPass != nullptr; }
angle::Result onFramebufferChange(FramebufferWgpu *framebufferWgpu, gl::Command command);
angle::Result flush(webgpu::RenderPassClosureReason);
void setColorAttachmentFormat(size_t colorIndex, WGPUTextureFormat format);
void setColorAttachmentFormats(const gl::DrawBuffersArray<WGPUTextureFormat> &formats);
void setDepthStencilFormat(WGPUTextureFormat format);
void setVertexAttribute(size_t attribIndex, webgpu::PackedVertexAttribute newAttrib);
void invalidateVertexBuffer(size_t slot);
void invalidateVertexBuffers();
void invalidateIndexBuffer();
void invalidateCurrentTextures();
void invalidateDriverUniforms();
void ensureCommandEncoderCreated();
angle::Result getCurrentCommandEncoder(webgpu::RenderPassClosureReason closureReason,
webgpu::CommandEncoderHandle *outHandle);
// Driver uniforms are managed by ContextWgpu.
webgpu::BindGroupLayoutHandle getDriverUniformBindGroupLayout()
{
ASSERT(mDriverUniformsBindGroupLayout);
return mDriverUniformsBindGroupLayout;
}
private:
// Dirty bits.
enum DirtyBitType : size_t
{
// The pipeline has changed and needs to be recreated.
DIRTY_BIT_RENDER_PIPELINE_DESC,
DIRTY_BIT_RENDER_PASS,
DIRTY_BIT_RENDER_PIPELINE_BINDING,
DIRTY_BIT_VIEWPORT,
DIRTY_BIT_SCISSOR,
DIRTY_BIT_BLEND_CONSTANT,
DIRTY_BIT_VERTEX_BUFFERS,
DIRTY_BIT_INDEX_BUFFER,
DIRTY_BIT_DRIVER_UNIFORMS,
DIRTY_BIT_BIND_GROUPS,
DIRTY_BIT_MAX,
};
static_assert(DIRTY_BIT_RENDER_PIPELINE_BINDING > DIRTY_BIT_RENDER_PIPELINE_DESC,
"Pipeline binding must be handled after the pipeline desc dirty bit");
// Dirty bit handlers that record commands or otherwise expect to manipulate the render pass
// that will be used for the draw call must be specified after DIRTY_BIT_RENDER_PASS.
static_assert(DIRTY_BIT_RENDER_PIPELINE_BINDING > DIRTY_BIT_RENDER_PASS,
"Render pass using dirty bit must be handled after the render pass dirty bit");
static_assert(DIRTY_BIT_BIND_GROUPS > DIRTY_BIT_DRIVER_UNIFORMS,
"Bind group creation must be handled after editing driver uniforms");
using DirtyBits = angle::BitSet<DIRTY_BIT_MAX>;
DirtyBits mDirtyBits;
gl::AttributesMask mDirtyVertexBuffers;
DirtyBits mNewRenderPassDirtyBits;
ANGLE_INLINE void invalidateCurrentRenderPipeline()
{
mDirtyBits.set(DIRTY_BIT_RENDER_PIPELINE_DESC);
}
angle::Result setupDraw(const gl::Context *context,
gl::PrimitiveMode mode,
GLint firstVertexOrInvalid,
GLsizei vertexOrIndexCount,
GLsizei instanceCount,
gl::DrawElementsType indexTypeOrInvalid,
const void *indices,
GLint baseVertex,
uint32_t *outFirstIndex,
uint32_t *indexCountOut);
angle::Result handleDirtyRenderPipelineDesc(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyRenderPipelineBinding(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyViewport(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyScissor(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyBlendConstant(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyVertexBuffers(const gl::AttributesMask &slots,
DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyIndexBuffer(gl::DrawElementsType indexType,
DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyBindGroups(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyDriverUniforms(DirtyBits::Iterator *dirtyBitsIterator);
angle::Result handleDirtyRenderPass(DirtyBits::Iterator *dirtyBitsIterator);
angle::ImageLoadContext mImageLoadContext;
DisplayWgpu *mDisplay;
webgpu::CommandEncoderHandle mCurrentCommandEncoder;
webgpu::RenderPassEncoderHandle mCurrentRenderPass;
webgpu::CommandBuffer mCommandBuffer;
webgpu::RenderPipelineDesc mRenderPipelineDesc;
webgpu::RenderPipelineHandle mCurrentGraphicsPipeline;
gl::AttributesMask mCurrentRenderPipelineAllAttributes;
gl::DrawElementsType mCurrentIndexBufferType = gl::DrawElementsType::InvalidEnum;
// Actual struct of driver uniforms that is copied to the GPU. Only stored to check if the next
// set of driver uniforms has changed.
DriverUniforms mDriverUniforms;
// Holds the binding group layout for the driver uniforms.
webgpu::BindGroupLayoutHandle mDriverUniformsBindGroupLayout;
// Holds the most recent driver uniforms BindGroup. Note there may be others in the
// command buffer.
webgpu::BindGroupHandle mDriverUniformsBindGroup;
};
} // namespace rx
#endif // LIBANGLE_RENDERER_WGPU_CONTEXTWGPU_H_