https://github.com/unitycoder/NatRender
High performance native graphics utilities for Unity Engine.
https://github.com/unitycoder/NatRender
Last synced: 8 days ago
JSON representation
High performance native graphics utilities for Unity Engine.
- Host: GitHub
- URL: https://github.com/unitycoder/NatRender
- Owner: unitycoder
- License: mit
- Created: 2021-04-21T11:25:55.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-02-28T01:18:53.000Z (almost 5 years ago)
- Last Synced: 2025-04-07T19:27:24.783Z (8 months ago)
- Homepage: https://docs.natsuite.io/natrender
- Size: 470 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
- anything_about_game - NatRender
README
# NatRender
NatRender is a lightweight graphics utility library for Unity Engine. Features include:
- High performance pixel buffer readbacks from the GPU on iOS and Android (including OpenGL ES3).
- Running delegates on Unity's render thread.
## Setup Instructions
NatShare should be installed using the Unity Package Manager. In your `manifest.json` file, add the following dependency:
```json
{
"dependencies": {
"com.natsuite.natrender": "git+https://github.com/natsuite/NatRender"
}
}
```
## Pixel Buffer Readbacks
NatRender provides lightweight primitives for performing pixel buffer readbacks from textures on the GPU. This is exposed through implementations the `IReadback` interface. Currently, NatRender provides the following implementations:
- `GLESReadback` for Android when rendering with OpenGL ES3.
- `MTLReadback` for iOS when rendering with Metal.
- `AsyncReadback` for platforms that support Unity's [async readbacks](https://docs.unity3d.com/ScriptReference/SystemInfo-supportsAsyncGPUReadback.html).
- `SyncReadback` for all platforms. Note that this implementation has the worst performance.
Once you create a readback, you can request the pixel data by calling the `Readback` method:
```csharp
// Starting with some texture you want to readback
var texture = ...;
// Create readback
var readback = new GLESReadback(...) or new MLTReadback(...) or ...;
// Issue request
readback.Request(texture, (NativeArray pixelBuffer) => {
// Do stuff with pixel buffer
});
// And when you're done remember to dispose
readback.Dispose();
```
## Running on the Render Thread
NatRender also provides a way to run an `Action` on Unity's render thread. This is useful for performing native rendering or doing anything that requires being on the primary render thread:
```csharp
RenderThread.Run(() => {
// We're on Unity's render thread
Debug.Log("Hello from the render thread");
});
```
___
## Requirements
- Unity 2019.2+
- Android API level 24+
- iOS 13+
## Resources
- [NatRender Documentation](https://docs.natsuite.io/natrender)
- [NatSuite Framework on GitHub](https://github.com/natsuite)
- [Email Support](mailto:yusuf@natsuite.io)
Thank you very much!