# GPUSpriteInstancing

**Repository Path**: q425163005/GPUSpriteInstancing

## Basic Information

- **Project Name**: GPUSpriteInstancing
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-25
- **Last Updated**: 2025-09-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GPU Sprite Instancing :zap:

## I. Overview

* GPUSpriteInstancing is a Unity package that provides efficient GPU-based sprite rendering using compute buffers and instancing
* Optimized with Unity Burst compiler and Job System for high-performance sprite rendering

<br />

<p align="center">
  <img src="/Assets/DocResources/Gifs/SampleDemo.gif" width="1000"> </p>

<p align="center"> Sample demo running on Mac with <u><strong>1,000,000 instances</strong></u> at <u><strong>> 100 FPS</strong></u> </p>

<p align="center"> Sample sprite source <a href="https://cupnooble.itch.io/sprout-lands-asset-pack">here</a> (Free) </p>

## II. Features

  <details>
  <summary>Core Features</summary>
  
  * GPU Instanced Sprite Rendering
  * Batched Drawing System
  * Sprite Atlas Support
  * Memory Management
  * Buffer Management
  * Job System Integration
  * Burst Compilation
  </details>

  <details>
  <summary>Components</summary>

  * GPU Sprite Manager
  * Instance Renderer
  * Custom Shader
  * Sprite Data Structure
  </details>

## III. Setup

### **>** Requirements

* Unity 2022.3 or higher
* Burst Package
* Mathematics Package

### **>** Installation

1. Open Package Manager from Window > Package Manager
2. Click on the "+" button > Add package from git URL
3. Enter the following URL:

```
https://github.com/centhoang/GPUSpriteInstancing.git?path=/Assets/GPUSpriteInstancing
```

Or open Packages/manifest.json and add the following to the dependencies block:

```json
{
    "dependencies": {
        "com.centhoang.gpu_sprite_instancing": "https://github.com/centhoang/GPUSpriteInstancing.git?path=/Assets/GPUSpriteInstancing"
    }
}
```

> [!IMPORTANT]
> Use `tag(#)` to avoid auto-fetching undesired version
>
> <sub>Example</sub>
> ```
> https://github.com/centhoang/GPUSpriteInstancing.git?path=/Assets/GPUSpriteInstancing#1.1.0
> ```

### **>** Intergration

1. Add a **GPUSpriteManager** component to a GameObject in your scene
2. Assign the **GPUSpriteInstancingMat** material (or your material which suits the system) to the manager
3. Create your sprite atlas texture
4. Use `GPUSpriteManager.UpdateSprites()` to render your sprites

###

## IV. Usage

### **>** Basic Implementation

```c#
// Create sprite data
var spriteData = new NativeArray<SpriteRendererData>(count, Allocator.Temp);
// Fill sprite data with positions, UVs, etc.

// Update and render sprites
spriteManager.UpdateSprites(spriteData, atlasTexture);

```

###

### **>** Best Practices

- Use shared texture atlases to minimize draw calls
- Keep sprite batches within the 1023 instance limit per draw call
- Dispose of NativeArrays when no longer needed
- Consider using object pooling for dynamic sprite systems

###

## V. Performance

- Optimized for rendering hundreds of thousands of sprites
- Minimal CPU overhead using Job System
- Efficient memory usage with compute buffers
- Batched rendering to reduce draw calls