/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef GPU_RenderPassEncoder_H_
#define GPU_RenderPassEncoder_H_
#include "CanvasContext.h"
#include "ObjectModel.h"
#include "mozilla/dom/TypedArray.h"
namespace mozilla {
class ErrorResult;
namespace dom {
class DoubleSequenceOrGPUColorDict;
enum class GPUIndexFormat : uint8_t;
struct GPURenderPassDescriptor;
template <
typename T>
class Sequence;
namespace binding_detail {
template <
typename T>
class AutoSequence;
}
// namespace binding_detail
}
// namespace dom
namespace webgpu {
namespace ffi {
struct WGPURecordedRenderPass;
}
// namespace ffi
class BindGroup;
class Buffer;
class CommandEncoder;
class RenderBundle;
class RenderPipeline;
class TextureView;
struct ffiWGPURenderPassDeleter {
void operator()(ffi::WGPURecordedRenderPass*);
};
class RenderPassEncoder final :
public nsWrapperCache,
public ObjectBase,
public ChildOf<CommandEncoder> {
public:
GPU_DECL_CYCLE_COLLECTION(RenderPassEncoder)
GPU_DECL_JS_WRAP(RenderPassEncoder)
RenderPassEncoder(CommandEncoder*
const aParent, RawId aId,
const dom::GPURenderPassDescriptor& aDesc);
protected:
virtual ~RenderPassEncoder();
std::unique_ptr<ffi::WGPURecordedRenderPass, ffiWGPURenderPassDeleter> mPass;
// keep all the used objects alive while the pass is recorded
nsTArray<RefPtr<
const BindGroup>> mUsedBindGroups;
nsTArray<RefPtr<
const Buffer>> mUsedBuffers;
nsTArray<RefPtr<
const RenderPipeline>> mUsedPipelines;
nsTArray<RefPtr<
const TextureView>> mUsedTextureViews;
nsTArray<RefPtr<
const RenderBundle>> mUsedRenderBundles;
// The canvas contexts of any canvas textures used in bind groups of this
// render pass.
CanvasContextArray mUsedCanvasContexts;
// programmable pass encoder
private:
bool mValid =
true;
void SetBindGroup(uint32_t aSlot, BindGroup*
const aBindGroup,
const uint32_t* aDynamicOffsets,
size_t aDynamicOffsetsLength);
public:
void Invalidate() { mValid =
false; }
void SetBindGroup(uint32_t aSlot, BindGroup*
const aBindGroup,
const dom::Sequence<uint32_t>& aDynamicOffsets,
ErrorResult& aRv);
void SetBindGroup(uint32_t aSlot, BindGroup*
const aBindGroup,
const dom::Uint32Array& aDynamicOffsetsData,
uint64_t aDynamicOffsetsDataStart,
uint64_t aDynamicOffsetsDataLength, ErrorResult& aRv);
// render encoder base
void SetPipeline(
const RenderPipeline& aPipeline);
void SetIndexBuffer(
const Buffer& aBuffer,
const dom::GPUIndexFormat& aIndexFormat, uint64_t aOffset,
const dom::Optional<uint64_t>& aSize);
void SetVertexBuffer(uint32_t aSlot,
const Buffer*
const aBuffer,
uint64_t aOffset,
const dom::Optional<uint64_t>& aSize);
void Draw(uint32_t aVertexCount, uint32_t aInstanceCount,
uint32_t aFirstVertex, uint32_t aFirstInstance);
void DrawIndexed(uint32_t aIndexCount, uint32_t aInstanceCount,
uint32_t aFirstIndex, int32_t aBaseVertex,
uint32_t aFirstInstance);
void DrawIndirect(
const Buffer& aIndirectBuffer, uint64_t aIndirectOffset);
void DrawIndexedIndirect(
const Buffer& aIndirectBuffer,
uint64_t aIndirectOffset);
// self
void SetViewport(
float x,
float y,
float width,
float height,
float minDepth,
float maxDepth);
void SetScissorRect(uint32_t x, uint32_t y, uint32_t width, uint32_t height);
void SetBlendConstant(
const dom::DoubleSequenceOrGPUColorDict& color);
void SetStencilReference(uint32_t reference);
void BeginOcclusionQuery(uint32_t queryIndex);
void EndOcclusionQuery();
void PushDebugGroup(
const nsAString& aString);
void PopDebugGroup();
void InsertDebugMarker(
const nsAString& aString);
void ExecuteBundles(
const dom::Sequence<OwningNonNull<RenderBundle>>& aBundles);
void End();
// helpers not defined by WebGPU
mozilla::Span<
const WeakPtr<CanvasContext>> GetCanvasContexts()
const {
return mUsedCanvasContexts;
}
};
}
// namespace webgpu
}
// namespace mozilla
#endif // GPU_RenderPassEncoder_H_
