WebGPU-raii

KO | EN

gitlite — search

#javascript #python #react #ai #go #golang #docker #nodejs #macos #security #pytorch #mcp #openai #open-source

(★ 10)

An RAII wrapper around the objects of the WebGPU native API.

WebGPU-raii Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

WebGPU RAII Wrapper
===================

This is a simple [RAII](https://en.cppreference.com/w/cpp/language/raii) wrapper around the objects of [the WebGPU native API](https://github.com/webgpu-native/webgpu-headers) that automatically releases them when they get out of scope.

A step by step introduction about its design is available in [the RAII chapter](https://eliemichel.github.io/LearnWebGPU/advanced-techniques/raii.html) of the LearnWebGPU guide.

Basic Usage
-----------

First of all, this assumes that you are already using my zero-overhead [`webgpu.hpp`](https://github.com/eliemichel/WebGPU-Cpp) wrapper to give a more C++ taste to the original C API.

Then simply add the file [`webgpu-raii.hpp`](webgpu-raii.hpp) to your source tree and include it.

For each object of the WebGPU API like `wgpu::Device` (a.k.a. `WGPUDevice`), the wrapper defines a `wgpu::raii::Device` object that behaves similarly except that it **can only be moved** (no copy semantics) and automatically calls `release()` when getting out of scope.

An RAII object can be created from a non RAII one by moving the non-RAII object. The latter must no longer be used once moved.

The RAII object can be dereferenced into the non RAII one as if it was a pointer, i.e., either usign the `*` operator, or through the `->` syntax.

```C++
#include "webgpu-raii.hpp"

using namespace wgpu;

// Without RAII
{
	Queue queue = device.getQueue();

queue.submit(/* [...] */);

queue.release();
}

// With RAII
{
	raii::Queue queue = device.getQueue();

queue->submit(/* [...] */);
	//   ^^ Note that we use the arrow operator here to access the submit
	//      method of the underlying object wgpu::Queue.

// No need to release, it is done automatically when getting out of scope.
}

// Convertion from non-RAII object
{
	Queue queue = device.getQueue();
	raii::Queue raiiQueue = std::move(queue);
	//                      ^^^^^^^^^ Move to make RAII the only owner of this

raiiQueue->submit(/* [...] */);

// No need to release anything
}
```

A more advanced example is available in [branch `step100-next-raii`](https://github.com/eliemichel/LearnWebGPU-Code/tree/step100-next-raii) of LearnWebGPU-Code.

WebGPU-raii

WebGPU-raii Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

WebGPU-raii

WebGPU-raii Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README