# Temaran/UnrealEngineShaderPluginDemo

A tutorial project that shows how to implement HLSL Pixel and Compute shaders in UE4

Repository: https://github.com/Temaran/UnrealEngineShaderPluginDemo
Canonical: https://ross.abutalabs.com/products/unrealengineshaderplugindemo
Language: C++
License: MIT
License Family: permissive
Last push: 2024-01-28T19:45:15+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 4224, "days_push": 948, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1007, forks 253 (observed 2026-08-28T04:03:12.406423+00:00)

## What it is
A tutorial project and plugin demonstrating how to implement custom HLSL pixel and compute shaders in Unreal Engine 4 via C++. It covers hosting .usf shader files, compilation macros, parameter structs, and render-thread invocation.

## Use cases
- learn how to add custom HLSL shaders to Unreal Engine 4
- implement compute shaders in UE4 with C++
- host custom .usf shader files in an Unreal plugin
- pass parameters to UE4 shaders from C++
- run rendering commands on the UE4 render thread
- bypass material editor and work directly with the RHI

## When to choose
- you want to write pixel or compute shaders directly against UE4's RHI instead of material graphs
- you need a worked example of shader plugin setup, compilation, and invocation in UE4
- you are learning how Unreal integrates HLSL shader files with C++ code

## When to avoid
- you want to learn HLSL or shader programming fundamentals from scratch
- you only need material effects achievable with Unreal's in-editor material tools
- you target engine versions without a matching branch

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: graphics, gpu-computing, sdk
- domain: graphics, tutorials
- platform: windows, cpp, game-engine
- tags: unreal-engine, hlsl, shaders, compute-shaders, pixel-shaders, tutorial-project, game-development

## Member repositories
- Temaran/UnrealEngineShaderPluginDemo (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:12.406423+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T07:12:24.903060+00:00, confidence not recorded.
  - readme: https://github.com/Temaran/UnrealEngineShaderPluginDemo (fetched 2026-08-28T04:03:12.406423+00:00, sha 6cb03dc139db)
- Data as of 2026-08-30T08:39:29.467469+00:00.