diff --git a/Ghost.Core/Ghost.Core.csproj b/Ghost.Core/Ghost.Core.csproj index c9aebd0..76b3753 100644 --- a/Ghost.Core/Ghost.Core.csproj +++ b/Ghost.Core/Ghost.Core.csproj @@ -26,6 +26,7 @@ + diff --git a/Ghost.Core/Graphics/ShaderDescriptor.cs b/Ghost.Core/Graphics/ShaderDescriptor.cs index d24b414..ff99e97 100644 --- a/Ghost.Core/Graphics/ShaderDescriptor.cs +++ b/Ghost.Core/Graphics/ShaderDescriptor.cs @@ -52,6 +52,7 @@ public struct PassDescriptor public string[] includes; public KeywordsGroup[] keywords; public PipelineState localPipeline; + public string? hlsl; } public class ShaderDescriptor @@ -61,6 +62,7 @@ public class ShaderDescriptor public PropertyDescriptor[] globalProperties = null!; public PropertyDescriptor[] properties = null!; public PassDescriptor[] passes = null!; + public string? hlsl; } public static class ShaderDescriptorExtensions diff --git a/Ghost.Core/Utilities/CollectionPool.cs b/Ghost.Core/Utilities/CollectionPool.cs new file mode 100644 index 0000000..b388bdf --- /dev/null +++ b/Ghost.Core/Utilities/CollectionPool.cs @@ -0,0 +1,22 @@ +using Misaki.HighPerformance.Buffer; + +namespace Ghost.Core.Utilities; + +public class CollectionPool + where TCollection : class, ICollection, new() +{ + internal static readonly ObjectPool s_pool = new ObjectPool(() => new TCollection(), 1); + + public static TCollection Rent() + { + return s_pool.Rent(); + } + + public static void Return(TCollection collection) + { + collection.Clear(); + s_pool.Return(collection); + } +} + +public class ListPool : CollectionPool, T>; \ No newline at end of file diff --git a/Ghost.DSL/Ghost.DSL.csproj b/Ghost.DSL/Ghost.DSL.csproj index 755478c..17e40af 100644 --- a/Ghost.DSL/Ghost.DSL.csproj +++ b/Ghost.DSL/Ghost.DSL.csproj @@ -7,11 +7,21 @@ - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - + + + + + + MSBuild:Compile + false + true + + + MSBuild:Compile + false + true + diff --git a/Ghost.DSL/Grammar/GhostShaderLexer.g4 b/Ghost.DSL/Grammar/GhostShaderLexer.g4 new file mode 100644 index 0000000..2f4f714 --- /dev/null +++ b/Ghost.DSL/Grammar/GhostShaderLexer.g4 @@ -0,0 +1,33 @@ +lexer grammar GhostShaderLexer; + +// Keywords +SHADER: 'shader'; +PROPERTIES: 'properties'; +PIPELINE: 'pipeline'; +PASS: 'pass'; +DEFINES: 'defines'; +KEYWORDS: 'keywords'; +INCLUDES: 'includes'; +GLOBAL: 'global'; +LOCAL: 'local'; +HLSL: 'hlsl'; + +// Punctuation +LBRACE: '{'; +RBRACE: '}'; +LPAREN: '('; +RPAREN: ')'; +SEMICOLON: ';'; +COMMA: ','; +EQUALS: '='; +COLON: ':'; + +// Literals +STRING_LITERAL: '"' (~["\r\n] | '\\' .)* '"'; +NUMBER: [0-9]+ ('.' [0-9]+)? | '.' [0-9]+; +IDENTIFIER: [a-zA-Z_][a-zA-Z0-9_]*; + +// Whitespace and Comments +WS: [ \t\r\n]+ -> skip; +LINE_COMMENT: '//' ~[\r\n]* -> skip; +BLOCK_COMMENT: '/*' .*? '*/' -> skip; diff --git a/Ghost.DSL/Grammar/GhostShaderParser.g4 b/Ghost.DSL/Grammar/GhostShaderParser.g4 new file mode 100644 index 0000000..5a26f98 --- /dev/null +++ b/Ghost.DSL/Grammar/GhostShaderParser.g4 @@ -0,0 +1,94 @@ +parser grammar GhostShaderParser; + +options { + tokenVocab = GhostShaderLexer; +} + +// Top-level rule +shaderFile: shader+ EOF; + +shader: + SHADER STRING_LITERAL LBRACE + shaderBody + RBRACE; + +shaderBody: + (propertiesBlock | pipelineBlock | passBlock | functionCall)*; + +// Properties block +propertiesBlock: + PROPERTIES LBRACE + propertyDeclaration* + RBRACE; + +propertyDeclaration: + scope? IDENTIFIER IDENTIFIER (EQUALS LBRACE propertyInitializer RBRACE)? SEMICOLON; + +scope: + GLOBAL | LOCAL; + +propertyInitializer: + (NUMBER | IDENTIFIER) (COMMA (NUMBER | IDENTIFIER))*; + +// Pipeline block +pipelineBlock: + PIPELINE LBRACE + pipelineStatement* + RBRACE; + +pipelineStatement: + IDENTIFIER EQUALS IDENTIFIER SEMICOLON; + +// Pass block +passBlock: + PASS STRING_LITERAL LBRACE + passBody + RBRACE; + +// Template +passBody: + (definesBlock | includesBlock | keywordsBlock | pipelineBlock | hlslBlock | shaderEntry)*; + +definesBlock: + DEFINES LBRACE + defineStatement* + RBRACE; + +defineStatement: + IDENTIFIER SEMICOLON; + +includesBlock: + INCLUDES LBRACE + includeStatement* + RBRACE; + +includeStatement: + STRING_LITERAL SEMICOLON; + +keywordsBlock: + KEYWORDS LBRACE + keywordStatement* + RBRACE; + +keywordStatement: + scope? IDENTIFIER (COMMA IDENTIFIER)* SEMICOLON; + +hlslBlock: + HLSL LBRACE + hlslCode + RBRACE; + +hlslCode: + .*? ; // Capture everything inside hlsl block + +shaderEntry: + IDENTIFIER STRING_LITERAL COLON STRING_LITERAL SEMICOLON; + +functionCall: + IDENTIFIER LPAREN functionArguments? RPAREN SEMICOLON; + +functionArguments: + functionArgument (COMMA functionArgument)*; + +functionArgument: + STRING_LITERAL | NUMBER | IDENTIFIER; diff --git a/Ghost.DSL/ShaderCompiler/DSLShaderCompiler.cs b/Ghost.DSL/ShaderCompiler/DSLShaderCompiler.cs index edba659..75626c7 100644 --- a/Ghost.DSL/ShaderCompiler/DSLShaderCompiler.cs +++ b/Ghost.DSL/ShaderCompiler/DSLShaderCompiler.cs @@ -1,6 +1,6 @@ using Ghost.Core; using Ghost.Core.Graphics; -using Ghost.DSL.ShaderCompiler.Parser; +using Ghost.DSL.ShaderParser; using System.Text; namespace Ghost.DSL.ShaderCompiler; @@ -22,107 +22,6 @@ internal static class DSLShaderCompiler private const string _GLOBAL_PROPERTY_FILE_NAME = "GlobalData.g.hlsl"; private const string _GENERATED_FILE_HEADER = "// Auto-generated shader file. Please do not edit this file directly."; - // private struct ShaderInheritance - // { - // public DSLShaderSemantics? parent; - // public List? children; - // } - - public static List ParseShaders(TokenStream stream) - { - var shaders = new List(); - - while (stream.TryPeek(out var nextToken)) - { - if (ShaderBlock.ShouldEnter(nextToken)) - { - var shader = ShaderBlock.Parse(stream.SliceNextBlock()); - shaders.Add(shader); - } - else if (nextToken.Match(TokenType.EndOfFile)) - { - stream.Consume(); - } - else - { - throw new Exception($"Unexpected token '{nextToken.lexeme}' at top level. Expected 'shader' declaration."); - } - } - - return shaders; - } - - public static DSLShaderSemantics? SemanticAnalysis(DSLShaderSyntax syntax, out List errors) - { - errors = new List(); - - if (string.IsNullOrWhiteSpace(syntax.name.lexeme)) - { - errors.Add(new DSLShaderError - { - message = "Shader name cannot be empty.", - line = syntax.name.line, - column = syntax.name.column - }); - - return null; - } - - var shaderModel = ShaderBlock.SemanticAnalysis(syntax, errors); - return shaderModel; - } - - private static List? TopologicalSort(ReadOnlySpan semantics) - { - var inDegrees = new Dictionary(); - var childrenMap = new Dictionary>(); - var semanticsMap = new Dictionary(); - - foreach (var s in semantics) - { - inDegrees[s.name] = 0; - childrenMap[s.name] = new List(); - semanticsMap[s.name] = s; - } - - foreach (var s in semantics) - { - if (!string.IsNullOrEmpty(s.fallback) && semanticsMap.ContainsKey(s.fallback)) - { - childrenMap[s.fallback].Add(s.name); - inDegrees[s.name]++; - } - } - - var queue = new Queue(); - foreach (var s in semantics) - { - if (inDegrees[s.name] == 0) - { - queue.Enqueue(s); - } - } - - var sortedList = new List(); - while (queue.Count > 0) - { - var current = queue.Dequeue(); - sortedList.Add(current); - - foreach (var childName in childrenMap[current.name]) - { - inDegrees[childName]--; - if (inDegrees[childName] == 0) - { - queue.Enqueue(semanticsMap[childName]); - } - } - } - - // If there's a cycle, the graph will not be fully traversed. - return sortedList.Count == semantics.Length ? sortedList : null; - } - private static string GetPassUniqueId(DSLShaderSemantics shader, PassSemantic pass) { return $"{shader.name}_{pass.name}"; @@ -175,7 +74,8 @@ internal static class DSLShaderCompiler { var descriptor = new ShaderDescriptor { - name = semantics.name + name = semantics.name, + hlsl = semantics.hlsl }; var shaderGlobalProperties = semantics.properties? @@ -217,7 +117,8 @@ internal static class DSLShaderCompiler localPipeline = localPipeline, defines = pass.defines?.ToArray() ?? Array.Empty(), includes = pass.includes?.ToArray() ?? Array.Empty(), - keywords = pass.keywords?.ToArray() ?? Array.Empty() + keywords = pass.keywords?.ToArray() ?? Array.Empty(), + hlsl = pass.hlsl }; } } @@ -235,15 +136,27 @@ internal static class DSLShaderCompiler { var source = File.ReadAllText(shaderPath); - var lexer = new Lexer(source); - var stream = new TokenStream(lexer.Tokenize()); - var shaderInfo = ParseShaders(stream); - if (shaderInfo.Count == 0) + // Use ANTLR4 parser + var shaderModels = AntlrShaderCompiler.ParseShaders(source, out var parseErrors); + + if (parseErrors.Count != 0) + { + var errorMessages = new StringBuilder(); + foreach (var error in parseErrors) + { + errorMessages.AppendLine(error.ToString()); + } + + return Result.Failure("Failed to parse shader due to errors:\n" + errorMessages.ToString()); + } + + if (shaderModels.Count == 0) { return Result.Failure("No shader found in the provided file."); } - var model = SemanticAnalysis(shaderInfo[0], out var errors); + // Convert to semantics + var model = AntlrShaderCompiler.ConvertToSemantics(shaderModels[0], out var errors); if (errors.Count != 0 || model == null) { diff --git a/Ghost.DSL/ShaderCompiler/DSLShaderSemantics.cs b/Ghost.DSL/ShaderCompiler/DSLShaderSemantics.cs index 6fd4179..d9883c0 100644 --- a/Ghost.DSL/ShaderCompiler/DSLShaderSemantics.cs +++ b/Ghost.DSL/ShaderCompiler/DSLShaderSemantics.cs @@ -8,7 +8,7 @@ public enum PropertyScope Local, } -internal class PropertySemantic +public class PropertySemantic { public PropertyScope scope; public ShaderPropertyType type; @@ -16,7 +16,7 @@ internal class PropertySemantic public object? defaultValue; } -internal class PipelineSemantic +public class PipelineSemantic { public ZTest? zTest; public ZWrite? zWrite; @@ -25,22 +25,23 @@ internal class PipelineSemantic public ColorWriteMask? colorMask; } -internal class PassSemantic +public class PassSemantic { public string name = string.Empty; public ShaderEntryPoint taskShader; public ShaderEntryPoint meshShader; public ShaderEntryPoint pixelShader; + public string? hlsl; public List? defines; public List? includes; public List? keywords; public PipelineSemantic? localPipeline; } -internal class DSLShaderSemantics +public class DSLShaderSemantics { public string name = string.Empty; - public string fallback = string.Empty; + public string? hlsl; public List? properties; public PipelineSemantic? pipeline; public List? passes; diff --git a/Ghost.DSL/ShaderCompiler/DSLShaderSyntax.cs b/Ghost.DSL/ShaderCompiler/DSLShaderSyntax.cs deleted file mode 100644 index 6a2cee6..0000000 --- a/Ghost.DSL/ShaderCompiler/DSLShaderSyntax.cs +++ /dev/null @@ -1,58 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler; - -internal struct FunctionCallDeclaration -{ - public Token name; - public List? arguments; -} - -internal struct PropertyDeclaration -{ - public Token scope; - public Token type; - public Token name; - public List? propertyInitializer; -} - -internal struct ValueDeclaration -{ - public Token name; - public Token value; -} - -internal struct HlslDeclaration -{ - public List? tokens; -} - -internal class PropertiesSyntax -{ - public List? properties; - public List? functionCalls; -} - -internal class PipelineSyntax -{ - public List? values; - public List? functionCalls; -} - -internal class PassSyntax -{ - public Token name; - public PipelineSyntax? localPipeline; - public HlslDeclaration? hlsl; - public List? defines; - public List? includes; - public List>? keywords; - public List? functionCalls; -} - -internal class DSLShaderSyntax -{ - public Token name; - public PropertiesSyntax? properties; - public PipelineSyntax? pipeline; - public List? passes; - public List? functionCalls; -} \ No newline at end of file diff --git a/Ghost.DSL/ShaderCompiler/Lexer.cs b/Ghost.DSL/ShaderCompiler/Lexer.cs deleted file mode 100644 index 3febff7..0000000 --- a/Ghost.DSL/ShaderCompiler/Lexer.cs +++ /dev/null @@ -1,310 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler; - -public class Lexer -{ - private readonly string _source; - private int _pos = 0; - private int _line = 1; // Lines typically start at 1 - private int _column = 1; // Columns typically start at 1 - - public Lexer(string source) - { - _source = source; - } - - public IEnumerable Tokenize() - { - while (!IsAtEnd()) - { - var token = ScanToken(); - if (token != Token.Null) - { - yield return token; - } - } - - yield return new Token(TokenType.EndOfFile, string.Empty, _line, _column); - } - - #region Core Scanning Logic - - private Token ScanToken() - { - var c = Consume(); - - // Rule 1: Skip whitespace and handle line tracking - if (char.IsWhiteSpace(c)) - { - HandleWhitespace(c); - return Token.Null; - } - - // Rule 2: Handle comments - if (c == '/') - { - if (HandleComments()) - { - return Token.Null; - } - // If not a comment, fall through to handle '/' as an operator if needed - } - - // Rule 3: Handle string literals - if (c == '"') - { - return ScanStringLiteral(); - } - - // Rule 4: Handle numeric literals - if (char.IsDigit(c) || (c == '.' && char.IsDigit(Peek()))) - { - return ScanNumericLiteral(c); - } - - // Rule 5: Handle identifiers and keywords - if (char.IsLetter(c) || c == '_') - { - return ScanIdentifierOrKeyword(c); - } - - // Rule 6: Handle single-character tokens (punctuation) - var punctuationToken = ScanPunctuation(c); - if (punctuationToken != Token.Null) - { - return punctuationToken; - } - - // Rule 7: Skip unknown characters (could log warning in production) - return Token.Null; - } - - #endregion - - #region Rule Implementations - - private void HandleWhitespace(char c) - { - if (c == '\n') - { - _line++; - _column = 1; - } - else if (c == '\r') - { - // Handle Windows line endings - peek for \n - if (Peek() == '\n') - { - Consume(); - } - - _line++; - _column = 1; - } - else - { - _column++; - } - } - - private bool HandleComments() - { - var next = Peek(); - - if (next == '/') // Single-line comment - { - return ScanSingleLineComment(); - } - else if (next == '*') // Multi-line comment - { - return ScanMultiLineComment(); - } - - return false; // Not a comment - } - - private bool ScanSingleLineComment() - { - // Skip the second '/' - Consume(); - - // Consume until end of line - while (!IsAtEnd() && Peek() != '\n' && Peek() != '\r') - { - Consume(); - } - - return true; - } - - private bool ScanMultiLineComment() - { - // Skip the '*' - Consume(); - - while (!IsAtEnd()) - { - var c = Consume(); - - if (c == '\n') - { - _line++; - _column = 1; - } - else if (c == '*' && Peek() == '/') - { - Consume(); // Consume closing '/' - return true; - } - else - { - _column++; - } - } - - // Unclosed comment - could throw error in production - return true; - } - - private Token ScanStringLiteral() - { - var startLine = _line; - var startColumn = _column - 1; // Account for opening quote - var start = _pos; - - while (!IsAtEnd() && Peek() != '"') - { - var c = Peek(); - if (c == '\n') - { - _line++; - _column = 1; - } - else if (c == '\\') - { - // Handle escape sequences - Consume(); // Skip backslash - if (!IsAtEnd()) - { - Consume(); - } - continue; - } - - Consume(); - } - - if (IsAtEnd()) - { - // Unterminated string - could throw error in production - var unterminatedText = _source[start.._pos]; - return new Token(TokenType.StringLiteral, unterminatedText, startLine, startColumn); - } - - var text = _source[start.._pos]; - Consume(); // Consume closing quote - - return new Token(TokenType.StringLiteral, text, startLine, startColumn); - } - - private Token ScanNumericLiteral(char firstChar) - { - var startColumn = _column - 1; - var start = _pos - 1; // Include the first character - - var hasDot = firstChar == '.'; - - while (!IsAtEnd()) - { - var c = Peek(); - if (char.IsDigit(c)) - { - Consume(); - } - else if (c == '.' && !hasDot) - { - hasDot = true; - Consume(); - } - else - { - break; - } - } - - var number = _source[start.._pos]; - return new Token(TokenType.Number, number, _line, startColumn); - } - - private Token ScanIdentifierOrKeyword(char firstChar) - { - var startColumn = _column - 1; - var start = _pos - 1; // Include the first character - - while (!IsAtEnd() && (char.IsLetterOrDigit(Peek()) || Peek() == '_')) - { - Consume(); - } - - var text = _source[start.._pos]; - var tokenType = DetermineIdentifierType(text); - - return new Token(tokenType, text, _line, startColumn); - } - - private Token ScanPunctuation(char c) - { - var startColumn = _column - 1; - - return c switch - { - '=' => new Token(TokenType.Equals, "=", _line, startColumn), - ';' => new Token(TokenType.Semicolon, ";", _line, startColumn), - ',' => new Token(TokenType.Comma, ",", _line, startColumn), - '{' => new Token(TokenType.LBrace, "{", _line, startColumn), - '}' => new Token(TokenType.RBrace, "}", _line, startColumn), - '(' => new Token(TokenType.LParen, "(", _line, startColumn), - ')' => new Token(TokenType.RParen, ")", _line, startColumn), - _ => Token.Null // Unknown punctuation - }; - } - - #endregion - - #region Classification Rules - - private static TokenType DetermineIdentifierType(string text) - { - // Rule: Check if it's a known keyword first - if (TokenLexicon.IsKeyword(text)) - { - return TokenType.Keyword; - } - - // Rule: All other identifiers are treated as identifiers - // (Could extend this to handle functions, types, etc. as separate token types) - return TokenType.Identifier; - } - - #endregion - - #region Helper Methods - - private bool IsAtEnd() => _pos >= _source.Length; - - private char Consume() - { - if (IsAtEnd()) - return '\0'; - - var c = _source[_pos]; - _pos++; - _column++; - return c; - } - - private char Peek() => IsAtEnd() ? '\0' : _source[_pos]; - - private char PeekNext() => _pos + 1 >= _source.Length ? '\0' : _source[_pos + 1]; - - #endregion -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/DefinesBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/DefinesBlock.cs deleted file mode 100644 index ff7e3cb..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/DefinesBlock.cs +++ /dev/null @@ -1,45 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class DefinesBlock : IBlockParser, List> -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.DEFINES); - } - - public static List Parse(TokenStreamSlice stream) - { - stream.Expect(TokenType.Keyword); - stream.Expect(TokenType.LBrace); - - var defines = new List(); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.HasMore) - { - var defineToken = bodyStream.Expect(TokenType.Identifier); - defines.Add(defineToken); - bodyStream.Expect(TokenType.Semicolon); - } - - stream.Expect(TokenType.RBrace); - - return defines; - } - - public static List? SemanticAnalysis(List? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var defines = new List(syntax.Count); - foreach (var defineToken in syntax) - { - defines.Add(defineToken.lexeme); - } - - return defines; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/IBlockParser.cs b/Ghost.DSL/ShaderCompiler/Parser/IBlockParser.cs deleted file mode 100644 index 597d294..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/IBlockParser.cs +++ /dev/null @@ -1,8 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal interface IBlockParser -{ - public static abstract bool ShouldEnter(Token token); - public static abstract T? Parse(TokenStreamSlice ts); - public static abstract U? SemanticAnalysis(T? syntax, List errors); -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/IncludesBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/IncludesBlock.cs deleted file mode 100644 index 4035bfd..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/IncludesBlock.cs +++ /dev/null @@ -1,59 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class IncludesBlock : IBlockParser, List> -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.INCLUDES); - } - - public static List Parse(TokenStreamSlice stream) - { - stream.Expect(TokenType.Keyword); - stream.Expect(TokenType.LBrace); - - var includes = new List(); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.HasMore) - { - var includeToken = bodyStream.Expect(TokenType.StringLiteral); - includes.Add(includeToken); - bodyStream.Expect(TokenType.Semicolon); - } - - stream.Expect(TokenType.RBrace); - - return includes; - } - - public static List? SemanticAnalysis(List? syntax, List errors) - { - if (syntax == null || syntax.Count == 0) - { - return null; - } - - var includes = new List(syntax.Count); - foreach (var includeToken in syntax) - { - var path = includeToken.lexeme; - if (File.Exists(path)) - { - includes.Add(path); - } - else - { - errors.Add(new DSLShaderError - { - message = $"Included file '{path}' not found.", - line = includeToken.line, - column = includeToken.column - }); - continue; - } - } - - return includes; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/KeywordsBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/KeywordsBlock.cs deleted file mode 100644 index d7d1e75..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/KeywordsBlock.cs +++ /dev/null @@ -1,100 +0,0 @@ -using Ghost.Core.Graphics; - -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class KeywordsBlock : IBlockParser>, List> -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.KEYWORDS); - } - - public static List> Parse(TokenStreamSlice stream) - { - stream.Expect(TokenType.Keyword); - stream.Expect(TokenType.LBrace); - - var keywords = new List>(); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.HasMore) - { - var keys = new List(); - while (!bodyStream.Match(TokenType.Semicolon)) - { - var expectType = TokenType.Identifier; - if (keys.Count == 0) - { - expectType |= TokenType.Keyword; - } - - var argument = bodyStream.Expect(expectType); - keys.Add(argument); - - if (bodyStream.Match(TokenType.Comma)) - { - bodyStream.Consume(); - } - } - - keywords.Add(keys); - bodyStream.Expect(TokenType.Semicolon); - } - - stream.Expect(TokenType.RBrace); - - return keywords; - } - - public static List? SemanticAnalysis(List>? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var keywords = new List(syntax.Count); - foreach (var keys in syntax) - { - if (keys.Count == 0) - { - continue; - } - - var group = new KeywordsGroup(); - group.space = keys[0].lexeme switch - { - TokenLexicon.KnownFunctions.LOCAL => KeywordSpace.Local, - TokenLexicon.KnownFunctions.GLOBAL => KeywordSpace.Global, - _ => KeywordSpace.Local - }; - - for (var i = 0; i < keys.Count; i++) - { - var token = keys[i]; - if (i == 0 && token.type == TokenType.Keyword) - { - continue; - } - - if (token.type != TokenType.Identifier) - { - errors.Add(new DSLShaderError - { - message = $"Invalid keyword '{token.lexeme}' in keywords block.", - line = token.line, - column = token.column - }); - continue; - } - - group.keywords ??= new List(keys.Count); - group.keywords.Add(token.lexeme); - } - - keywords.Add(group); - } - - return keywords; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/ParseUtility.cs b/Ghost.DSL/ShaderCompiler/Parser/ParseUtility.cs deleted file mode 100644 index ac9edcb..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/ParseUtility.cs +++ /dev/null @@ -1,71 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal static class ParseUtility -{ - public static List ParseFunctionArguments(ref TokenStreamSlice stream, TokenType tokenType) - { - var args = new List(); - stream.Expect(TokenType.LParen); - - while (!stream.Peek().type.Equals(TokenType.RParen)) - { - var argToken = stream.Expect(tokenType); - args.Add(argToken); - - if (stream.Peek().type == TokenType.Comma) - { - stream.Consume(); - } - else - { - break; - } - } - - stream.Expect(TokenType.RParen); - return args; - } - - public static FunctionCallDeclaration ParseFunction(ref TokenStreamSlice stream, TokenType tokenType) - { - var functionToken = stream.Expect(TokenType.Identifier); - var args = ParseFunctionArguments(ref stream, tokenType); - stream.Expect(TokenType.Semicolon); - - return new FunctionCallDeclaration - { - name = functionToken, - arguments = args - }; - } - - public static bool TrySliceLine(ref TokenStreamSlice stream, out TokenStreamSlice lineStream) - { - var length = 0; - if (!stream.TryPeek(out var nextToken)) - { - lineStream = default; - return false; - } - - while (!nextToken.Match(TokenType.Semicolon) && !nextToken.Match(TokenType.RBrace)) - { - length++; - - if (!stream.TryPeek(length, out nextToken)) - { - break; - } - } - - if (length > 0) - { - lineStream = stream.Slice(length); - stream.Consume(); // Consume the semicolon - return true; - } - - lineStream = default; - return false; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/PassBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/PassBlock.cs deleted file mode 100644 index 0e1f1c4..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/PassBlock.cs +++ /dev/null @@ -1,141 +0,0 @@ -using Ghost.Core.Graphics; - -namespace Ghost.DSL.ShaderCompiler.Parser; - -// TODO: Add pass template support. -// Pass templates let user to inject their own custom code into the generated HLSL code. -// This is useful for adding custom lighting models, custom shadowing techniques, or other advanced effects without touching the core shader code. -internal class PassBlock : IBlockParser -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.PASS); - } - - public static PassSyntax Parse(TokenStreamSlice stream) - { - var pass = new PassSyntax(); - - stream.Expect(TokenType.Keyword); - pass.name = stream.Expect(TokenType.StringLiteral); - stream.Expect(TokenType.LBrace); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.TryPeek(out var nextToken)) - { - if (DefinesBlock.ShouldEnter(nextToken)) - { - pass.defines = DefinesBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (KeywordsBlock.ShouldEnter(nextToken)) - { - pass.keywords = KeywordsBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (PipelineBlock.ShouldEnter(nextToken)) - { - pass.localPipeline = PipelineBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (IncludesBlock.ShouldEnter(nextToken)) - { - pass.includes = IncludesBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (nextToken.Match(TokenType.Identifier)) - { - var func = ParseUtility.ParseFunction(ref bodyStream, TokenType.StringLiteral); - - pass.functionCalls ??= new(); - pass.functionCalls.Add(func); - } - else - { - throw new Exception($"Unexpected token '{nextToken}' in pass body."); - } - } - - stream.Expect(TokenType.RBrace); - - return pass; - } - - public static PassSemantic? SemanticAnalysis(PassSyntax? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var semantic = new PassSemantic - { - name = syntax.name.lexeme, - defines = DefinesBlock.SemanticAnalysis(syntax.defines, errors), - includes = IncludesBlock.SemanticAnalysis(syntax.includes, errors), - keywords = KeywordsBlock.SemanticAnalysis(syntax.keywords, errors), - localPipeline = PipelineBlock.SemanticAnalysis(syntax.localPipeline, errors), - }; - - if (syntax.functionCalls != null) - { - foreach (var func in syntax.functionCalls) - { - switch (func.name.lexeme) - { - case TokenLexicon.KnownFunctions.TASK_SHADER: - AnalysisShaderEntry(errors, func, ref semantic.taskShader); - break; - - case TokenLexicon.KnownFunctions.MESH_SHADER: - AnalysisShaderEntry(errors, func, ref semantic.meshShader); - break; - - case TokenLexicon.KnownFunctions.PIXEL_SHADER: - AnalysisShaderEntry(errors, func, ref semantic.pixelShader); - break; - - default: - errors.Add(new DSLShaderError - { - message = $"Unknown function '{func.name.lexeme}' in pass {syntax.name.lexeme}.", - line = func.name.line, - column = func.name.column - }); - break; - } - } - } - - if (semantic.meshShader.shader == null || semantic.pixelShader.shader == null) - { - // TODO: Inheritance from base pass. - // TODO: Add mesh shader support. - errors.Add(new DSLShaderError - { - message = $"Pass {syntax.name.lexeme} must contain a mesh shader (ms) and a pixel shader (ps) declaration.", - line = syntax.name.line, - column = syntax.name.column - }); - } - - return semantic; - } - - private static void AnalysisShaderEntry(List errors, FunctionCallDeclaration func, ref ShaderEntryPoint shaderEntryPoint) - { - if (func.arguments?.Count != 2) - { - errors.Add(new DSLShaderError - { - message = "Shader declaration requires exactly two arguments: (shaderPath, entryPoint).", - line = func.name.line, - column = func.name.column - }); - } - else - { - shaderEntryPoint = new ShaderEntryPoint - { - shader = func.arguments[0].lexeme, - entry = func.arguments[1].lexeme - }; - } - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/PipelineBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/PipelineBlock.cs deleted file mode 100644 index f9c3a72..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/PipelineBlock.cs +++ /dev/null @@ -1,143 +0,0 @@ -using Ghost.Core.Graphics; - -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class PipelineBlock : IBlockParser -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.PIPELINE); - } - - public static PipelineSyntax Parse(TokenStreamSlice stream) - { - stream.Expect(TokenType.Keyword); - stream.Expect(TokenType.LBrace); - - var pipeline = new PipelineSyntax(); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.HasMore) - { - var stateToken = bodyStream.Expect(TokenType.Identifier); - bodyStream.Expect(TokenType.Equals); - var valueToken = bodyStream.Expect(TokenType.Identifier | TokenType.Number); - - pipeline.values ??= new(); - pipeline.values.Add(new ValueDeclaration - { - name = stateToken, - value = valueToken - }); - - bodyStream.Expect(TokenType.Semicolon); - } - - stream.Expect(TokenType.RBrace); - - return pipeline; - } - - public static PipelineSemantic? SemanticAnalysis(PipelineSyntax? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var semantic = new PipelineSemantic(); - if (syntax.values != null) - { - foreach (var valueDecl in syntax.values) - { - switch (valueDecl.name.lexeme) - { - case TokenLexicon.KnownPipelineProperties.ZTEST: - if (Enum.TryParse(valueDecl.value.lexeme, true, out var zTest)) - { - semantic.zTest = zTest; - } - else - { - errors.Add(new DSLShaderError - { - message = $"Invalid ZTest option: {valueDecl.value.lexeme}", - line = valueDecl.value.line, - column = valueDecl.value.column - }); - } - break; - - case TokenLexicon.KnownPipelineProperties.ZWRITE: - if (Enum.TryParse(valueDecl.value.lexeme, true, out var zWrite)) - { - semantic.zWrite = zWrite; - } - else - { - errors.Add(new DSLShaderError - { - message = $"Invalid ZWrite option: {valueDecl.value.lexeme}", - line = valueDecl.value.line, - column = valueDecl.value.column - }); - } - break; - - case TokenLexicon.KnownPipelineProperties.CULL: - if (Enum.TryParse(valueDecl.value.lexeme, true, out var cull)) - { - semantic.cull = cull; - } - else - { - errors.Add(new DSLShaderError - { - message = $"Invalid Cull option: {valueDecl.value.lexeme}", - line = valueDecl.value.line, - column = valueDecl.value.column - }); - } - break; - - case TokenLexicon.KnownPipelineProperties.BLEND: - if (Enum.TryParse(valueDecl.value.lexeme, true, out var blend)) - { - semantic.blend = blend; - } - else - { - errors.Add(new DSLShaderError - { - message = $"Invalid Blend option: {valueDecl.value.lexeme}", - line = valueDecl.value.line, - column = valueDecl.value.column - }); - } - break; - - case TokenLexicon.KnownPipelineProperties.COLORMASK: - if (Enum.TryParse(valueDecl.value.lexeme, true, out var colorMask)) - { - semantic.colorMask = colorMask; - } - else - { - errors.Add(new DSLShaderError - { - message = $"Invalid Color Mask value: {valueDecl.value.lexeme}", - line = valueDecl.value.line, - column = valueDecl.value.column - }); - } - break; - - default: - break; - } - } - } - - return semantic; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/PropertiesBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/PropertiesBlock.cs deleted file mode 100644 index 3429a85..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/PropertiesBlock.cs +++ /dev/null @@ -1,437 +0,0 @@ -using Ghost.Core.Graphics; -using Misaki.HighPerformance.Mathematics; -using System.Globalization; - -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class PropertiesBlock : IBlockParser> -{ - private delegate object? PropertyValueBuilder(List tokens, List errors); - - private sealed record PropTypeInfo(int ArgCount, TokenType ArgTokenType, PropertyValueBuilder? Builder); - - private static readonly Dictionary s_propTypeInfo = new() - { - // Floats - [ShaderPropertyType.Float] = new(1, TokenType.Number, (syntax, errors) => ParseFloatValue(syntax[0], errors)), - [ShaderPropertyType.Float2] = new(2, TokenType.Number, (syntax, errors) => new float2( - ParseFloatValue(syntax[0], errors), - ParseFloatValue(syntax[1], errors))), - [ShaderPropertyType.Float3] = new(3, TokenType.Number, (syntax, errors) => new float3( - ParseFloatValue(syntax[0], errors), - ParseFloatValue(syntax[1], errors), - ParseFloatValue(syntax[2], errors))), - [ShaderPropertyType.Float4] = new(4, TokenType.Number, (syntax, errors) => new float4( - ParseFloatValue(syntax[0], errors), - ParseFloatValue(syntax[1], errors), - ParseFloatValue(syntax[2], errors), - ParseFloatValue(syntax[3], errors))), - - // Ints - [ShaderPropertyType.Int] = new(1, TokenType.Number, (syntax, errors) => ParseIntValue(syntax[0], errors)), - [ShaderPropertyType.Int2] = new(2, TokenType.Number, (syntax, errors) => new int2( - ParseIntValue(syntax[0], errors), - ParseIntValue(syntax[1], errors))), - [ShaderPropertyType.Int3] = new(3, TokenType.Number, (syntax, errors) => new int3( - ParseIntValue(syntax[0], errors), - ParseIntValue(syntax[1], errors), - ParseIntValue(syntax[2], errors))), - [ShaderPropertyType.Int4] = new(4, TokenType.Number, (syntax, errors) => new int4( - ParseIntValue(syntax[0], errors), - ParseIntValue(syntax[1], errors), - ParseIntValue(syntax[2], errors), - ParseIntValue(syntax[3], errors))), - - // UInts - [ShaderPropertyType.UInt] = new(1, TokenType.Number, (syntax, errors) => ParseUIntValue(syntax[0], errors)), - [ShaderPropertyType.UInt2] = new(2, TokenType.Number, (syntax, errors) => new uint2( - ParseUIntValue(syntax[0], errors), - ParseUIntValue(syntax[1], errors))), - [ShaderPropertyType.UInt3] = new(3, TokenType.Number, (syntax, errors) => new uint3( - ParseUIntValue(syntax[0], errors), - ParseUIntValue(syntax[1], errors), - ParseUIntValue(syntax[2], errors))), - [ShaderPropertyType.UInt4] = new(4, TokenType.Number, (syntax, errors) => new uint4( - ParseUIntValue(syntax[0], errors), - ParseUIntValue(syntax[1], errors), - ParseUIntValue(syntax[2], errors), - ParseUIntValue(syntax[3], errors))), - - // Bools (numbers 0/1) - [ShaderPropertyType.Bool] = new(1, TokenType.Number, (syntax, errors) => ParseBoolValue(syntax[0], errors)), - [ShaderPropertyType.Bool2] = new(2, TokenType.Number, (syntax, errors) => new bool2( - ParseBoolValue(syntax[0], errors), - ParseBoolValue(syntax[1], errors))), - [ShaderPropertyType.Bool3] = new(3, TokenType.Number, (syntax, errors) => new bool3( - ParseBoolValue(syntax[0], errors), - ParseBoolValue(syntax[1], errors), - ParseBoolValue(syntax[2], errors))), - [ShaderPropertyType.Bool4] = new(4, TokenType.Number, (syntax, errors) => new bool4( - ParseBoolValue(syntax[0], errors), - ParseBoolValue(syntax[1], errors), - ParseBoolValue(syntax[2], errors), - ParseBoolValue(syntax[3], errors))), - - // Textures (single identifier argument) - [ShaderPropertyType.Texture2D] = new(1, TokenType.Identifier, (syntax, errors) => ParseTextureDefault(syntax[0], errors)), - [ShaderPropertyType.Texture3D] = new(1, TokenType.Identifier, (syntax, errors) => ParseTextureDefault(syntax[0], errors)), - [ShaderPropertyType.TextureCube] = new(1, TokenType.Identifier, (syntax, errors) => ParseTextureDefault(syntax[0], errors)), - }; - - private static float ParseFloatValue(Token token, List errors) - { - if (!float.TryParse(token.lexeme, CultureInfo.InvariantCulture, out var result)) - { - errors.Add(new DSLShaderError - { - message = $"Failed to parse float value '{token.lexeme}'.", - line = token.line, - column = token.column - }); - } - - return result; - } - - private static int ParseIntValue(Token token, List errors) - { - if (!int.TryParse(token.lexeme, CultureInfo.InvariantCulture, out var result)) - { - errors.Add(new DSLShaderError - { - message = $"Failed to parse int value '{token.lexeme}'.", - line = token.line, - column = token.column - }); - } - - return result; - } - - private static uint ParseUIntValue(Token token, List errors) - { - if (!uint.TryParse(token.lexeme, CultureInfo.InvariantCulture, out var result)) - { - errors.Add(new DSLShaderError - { - message = $"Failed to parse uint value '{token.lexeme}'.", - line = token.line, - column = token.column - }); - } - - return result; - } - - private static bool ParseBoolValue(Token token, List errors) - { - if (!bool.TryParse(token.lexeme, out var result)) - { - errors.Add(new DSLShaderError - { - message = $"Failed to parse bool value '{token.lexeme}'.", - line = token.line, - column = token.column - }); - } - - return result; - } - - private static string ParseTextureDefault(Token token, List errors) - { - if (!TokenLexicon.IsTextureDefaultValue(token.lexeme)) - { - errors.Add(new DSLShaderError - { - message = $"Texture default value '{token.lexeme}' is not valid.", - line = token.line, - column = token.column - }); - } - - return token.lexeme; - } - - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.PROPERTIES); - } - - private static ShaderPropertyType FromString(string type) - { - return type.ToLower() switch - { - TokenLexicon.KnownTypes.FLOAT => ShaderPropertyType.Float, - TokenLexicon.KnownTypes.FLOAT2 => ShaderPropertyType.Float2, - TokenLexicon.KnownTypes.FLOAT3 => ShaderPropertyType.Float3, - TokenLexicon.KnownTypes.FLOAT4 => ShaderPropertyType.Float4, - TokenLexicon.KnownTypes.FLOAT4X4 => ShaderPropertyType.Float4x4, - TokenLexicon.KnownTypes.INT => ShaderPropertyType.Int, - TokenLexicon.KnownTypes.INT2 => ShaderPropertyType.Int2, - TokenLexicon.KnownTypes.INT3 => ShaderPropertyType.Int3, - TokenLexicon.KnownTypes.INT4 => ShaderPropertyType.Int4, - TokenLexicon.KnownTypes.UINT => ShaderPropertyType.UInt, - TokenLexicon.KnownTypes.UINT2 => ShaderPropertyType.UInt2, - TokenLexicon.KnownTypes.UINT3 => ShaderPropertyType.UInt3, - TokenLexicon.KnownTypes.UINT4 => ShaderPropertyType.UInt4, - TokenLexicon.KnownTypes.BOOL => ShaderPropertyType.Bool, - TokenLexicon.KnownTypes.BOOL2 => ShaderPropertyType.Bool2, - TokenLexicon.KnownTypes.BOOL3 => ShaderPropertyType.Bool3, - TokenLexicon.KnownTypes.BOOL4 => ShaderPropertyType.Bool4, - TokenLexicon.KnownTypes.TEXTURE2D => ShaderPropertyType.Texture2D, - TokenLexicon.KnownTypes.TEXTURE3D => ShaderPropertyType.Texture3D, - TokenLexicon.KnownTypes.TEXTURECUBE => ShaderPropertyType.TextureCube, - TokenLexicon.KnownTypes.TEXTURECUBE_ARRAY => ShaderPropertyType.TextureCubeArray, - TokenLexicon.KnownTypes.TEXTURE2D_ARRAY => ShaderPropertyType.Texture2DArray, - TokenLexicon.KnownTypes.SAMPLER => ShaderPropertyType.Sampler, - _ => ShaderPropertyType.None, - }; - } - - public static PropertiesSyntax Parse(TokenStreamSlice stream) - { - stream.Expect(TokenType.Keyword); - stream.Expect(TokenType.LBrace); - - var syntax = new PropertiesSyntax(); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.HasMore) - { - var shaderProperty = new PropertyDeclaration(); - if (bodyStream.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.GLOBAL) - || bodyStream.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.LOCAL)) - { - var scopeToken = bodyStream.Consume(); - shaderProperty.scope = scopeToken; - } - - var typeToken = bodyStream.Expect(TokenType.Identifier); - var nameToken = bodyStream.Expect(TokenType.Identifier); - - shaderProperty.type = typeToken; - shaderProperty.name = nameToken; - - var nextToken = bodyStream.Consume(); - switch (nextToken.type) - { - case TokenType.Equals: - { - bodyStream.Expect(TokenType.LBrace); - while (!bodyStream.Match(TokenType.RBrace)) - { - var token = bodyStream.Consume(); - if (!token.Match(TokenType.Comma)) - { - shaderProperty.propertyInitializer ??= new List(); - shaderProperty.propertyInitializer.Add(token); - } - } - - bodyStream.Expect(TokenType.RBrace); - bodyStream.Expect(TokenType.Semicolon); - - break; - } - - case TokenType.Semicolon: - break; - default: - throw new Exception($"Unexpected token '{nextToken.lexeme}' in property declaration."); - } - - syntax.properties ??= new(); - syntax.properties.Add(shaderProperty); - } - - stream.Expect(TokenType.RBrace); - - return syntax; - } - - public static List? SemanticAnalysis(PropertiesSyntax? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var models = new List(); - var usedPropertyNames = new HashSet(); - - if (syntax.properties != null) - { - foreach (var property in syntax.properties) - { - var model = new PropertySemantic - { - scope = property.scope.lexeme switch - { - TokenLexicon.KnownKeywords.GLOBAL => PropertyScope.Global, - TokenLexicon.KnownKeywords.LOCAL => PropertyScope.Local, - _ => PropertyScope.Local, - } - }; - - var flowControl = ValidatePropertyType(errors, property, model); - if (!flowControl) - { - continue; - } - - flowControl = ValidatePropertyName(errors, usedPropertyNames, property, model); - if (!flowControl) - { - continue; - } - - if (property.propertyInitializer != null) - { - flowControl = ValidatePropertyInitializer(errors, property, model); - if (!flowControl) - { - continue; - } - } - - usedPropertyNames.Add(property.name.lexeme); - models.Add(model); - } - } - - return models; - } - - private static bool ValidatePropertyType(List errors, PropertyDeclaration property, PropertySemantic model) - { - if (!TokenLexicon.IsType(property.type.lexeme)) - { - errors.Add(new DSLShaderError - { - message = $"Shader property type '{property.type.lexeme}' is not a valid type.", - line = property.type.line, - column = property.type.column - }); - - return false; - } - - model.type = FromString(property.type.lexeme); - return true; - } - - private static bool ValidatePropertyName(List errors, HashSet usedPropertyNames, PropertyDeclaration property, PropertySemantic model) - { - if (string.IsNullOrWhiteSpace(property.name.lexeme)) - { - errors.Add(new DSLShaderError - { - message = "Shader property has an empty name.", - line = property.name.line, - column = property.name.column - }); - - return false; - } - else if (usedPropertyNames.Contains(property.name.lexeme)) - { - errors.Add(new DSLShaderError - { - message = $"Shader property name '{property.name.lexeme}' is duplicated.", - line = property.name.line, - column = property.name.column - }); - - return false; - } - - model.name = property.name.lexeme; - return true; - } - - private static bool ValidatePropertyInitializer(List errors, PropertyDeclaration property, PropertySemantic model) - { - var initializer = property.propertyInitializer; - if (initializer == null) - { - errors.Add(new DSLShaderError - { - message = "Shader property initializer is null.", - line = property.name.line, - column = property.name.column - }); - - return false; - } - - if (!s_propTypeInfo.TryGetValue(model.type, out var info)) - { - errors.Add(new DSLShaderError - { - message = $"No initializer metadata registered for property type '{model.type}'.", - line = property.name.line, - column = property.name.column - }); - - return false; - } - - if (initializer.Count != info.ArgCount) - { - errors.Add(new DSLShaderError - { - message = $"Shader property constructor for type '{property.type.lexeme}' expects {info.ArgCount} argument(s), but got {initializer.Count}.", - line = property.name.line, - column = property.name.column - }); - - return false; - } - - // Type check (uniform requirement for all args) - var hasError = false; - for (var i = 0; i < initializer.Count; i++) - { - var arg = initializer[i]; - if (!arg.Match(info.ArgTokenType)) - { - errors.Add(new DSLShaderError - { - message = $"Shader property constructor argument {i} expects token kind '{info.ArgTokenType}', but got '{arg.type}'.", - line = arg.line, - column = arg.column - }); - - hasError = true; - } - } - - if (hasError) - { - return false; - } - - // Build default Value if we have a builder (textures currently null / TODO) - if (info.Builder != null) - { - try - { - model.defaultValue = info.Builder(initializer, errors); - } - catch (Exception ex) - { - errors.Add(new DSLShaderError - { - message = $"Failed to construct default value for property '{property.name.lexeme}': {ex.Message}", - line = property.name.line, - column = property.name.column - }); - - return false; - } - } - - return true; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Parser/ShaderBlock.cs b/Ghost.DSL/ShaderCompiler/Parser/ShaderBlock.cs deleted file mode 100644 index 6270531..0000000 --- a/Ghost.DSL/ShaderCompiler/Parser/ShaderBlock.cs +++ /dev/null @@ -1,114 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler.Parser; - -internal class ShaderBlock : IBlockParser -{ - public static bool ShouldEnter(Token token) - { - return token.Match(TokenType.Keyword, TokenLexicon.KnownKeywords.SHADER); - } - - public static DSLShaderSyntax Parse(TokenStreamSlice stream) - { - var shader = new DSLShaderSyntax(); - - stream.Expect(TokenType.Keyword); - shader.name = stream.Expect(TokenType.StringLiteral); - stream.Expect(TokenType.LBrace); - - var bodyStream = stream.Slice(stream.Remaining - 1); - while (bodyStream.TryPeek(out var nextToken)) - { - if (PropertiesBlock.ShouldEnter(nextToken)) - { - shader.properties = PropertiesBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (PipelineBlock.ShouldEnter(nextToken)) - { - shader.pipeline = PipelineBlock.Parse(bodyStream.SliceNextBlock()); - } - else if (PassBlock.ShouldEnter(nextToken)) - { - shader.passes ??= new(); - shader.passes.Add(PassBlock.Parse(bodyStream.SliceNextBlock())); - } - else if (nextToken.Match(TokenType.Identifier)) - { - var func = ParseUtility.ParseFunction(ref bodyStream, TokenType.StringLiteral | TokenType.Number | TokenType.Identifier); - - shader.functionCalls ??= new(); - shader.functionCalls.Add(func); - } - else - { - throw new Exception($"Unexpected token '{nextToken}' in shader body."); - } - } - - stream.Expect(TokenType.RBrace); - - return shader; - } - - public static DSLShaderSemantics? SemanticAnalysis(DSLShaderSyntax? syntax, List errors) - { - if (syntax == null) - { - return null; - } - - var shaderModel = new DSLShaderSemantics - { - name = syntax.name.lexeme, - properties = PropertiesBlock.SemanticAnalysis(syntax.properties, errors), - pipeline = PipelineBlock.SemanticAnalysis(syntax.pipeline, errors) - }; - - if (syntax.passes != null) - { - foreach (var passSyntax in syntax.passes) - { - var passModel = PassBlock.SemanticAnalysis(passSyntax, errors); - if (passModel != null) - { - shaderModel.passes ??= new(); - shaderModel.passes.Add(passModel); - } - } - } - - if (syntax.functionCalls != null) - { - foreach (var func in syntax.functionCalls) - { - switch (func.name.lexeme) - { - case TokenLexicon.KnownFunctions.FALLBACK: - if (func.arguments == null || func.arguments.Count != 1) - { - errors.Add(new DSLShaderError - { - message = "Fallback declaration requires exactly one arguments: (fallback shader name).", - line = func.name.line, - column = func.name.column - }); - - continue; - } - - shaderModel.fallback = func.arguments[0].lexeme; - break; - default: - errors.Add(new DSLShaderError - { - message = $"Unknown function '{func.name.lexeme}' in shader.", - line = func.name.line, - column = func.name.column - }); - break; - } - } - } - - return shaderModel; - } -} diff --git a/Ghost.DSL/ShaderCompiler/Token.cs b/Ghost.DSL/ShaderCompiler/Token.cs deleted file mode 100644 index 66485fc..0000000 --- a/Ghost.DSL/ShaderCompiler/Token.cs +++ /dev/null @@ -1,242 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler; - -[Flags] -public enum TokenType -{ - None = 0, - - // Literals - Identifier = 1 << 0, // variable names, function names, etc. - Keyword = 1 << 1, // shader, properties, pipeline, pass, etc. - Number = 1 << 2, // numeric literals (123, 45.67, .5) - StringLiteral = 1 << 3, // "ForwardVS.hlsl" - - // Operators and Punctuation - Equals = 1 << 4, // = - Semicolon = 1 << 5, // ; - Comma = 1 << 6, // , - - // Delimiters - LBrace = 1 << 7, // { - RBrace = 1 << 8, // } - LParen = 1 << 9, // ( - RParen = 1 << 10, // ) - - // Special - EndOfFile = 1 << 11, // EOF - - // Future extensions (commented out for now) - // LBracket = 1 << 12, // [ - // RBracket = 1 << 13, // ] - // Dot = 1 << 14, // . - // Colon = 1 << 15, // : - // Plus = 1 << 16, // + - // Minus = 1 << 17, // - - // Star = 1 << 18, // * - // Slash = 1 << 19, // / -} - -public readonly struct Token : IEquatable -{ - public readonly TokenType type; - public readonly string lexeme; - public readonly int line; - public readonly int column; - - public static Token Null => new Token(TokenType.None, string.Empty, -1, -1); - - public Token(TokenType type, string lexeme, int line, int column) - { - this.type = type; - this.lexeme = lexeme; - this.line = line; - this.column = column; - } - - public override readonly string ToString() - { - return $"{type}('{lexeme}') at {line}:{column}"; - } - - public bool Equals(Token other) - { - return type == other.type && lexeme == other.lexeme && line == other.line && column == other.column; - } - - public override int GetHashCode() - { - return HashCode.Combine(type, lexeme, line, column); - } - - public override bool Equals(object? obj) - { - return obj is Token token && Equals(token); - } - - public static bool operator ==(Token left, Token right) - { - return left.Equals(right); - } - - public static bool operator !=(Token left, Token right) - { - return !(left == right); - } -} - -public static class TokenExtensions -{ - public static bool Match(this Token token, TokenType type, string? lexeme = null) - { - if (!type.HasFlag(token.type)) - { - return false; - } - - if (!string.IsNullOrEmpty(lexeme) && token.lexeme != lexeme) - { - return false; - } - - return true; - } - - public static void Expect(this Token token, TokenType type, string? lexeme = null) - { - if (!token.Match(type, lexeme)) - { - var expected = lexeme != null ? $"{type}('{lexeme}')" : type.ToString(); - throw new Exception($"Unexpected token at line {token.line}, column {token.column}. Expected {expected}, got {token.type}('{token.lexeme}')."); - } - } -} - -internal static class TokenLexicon -{ - public static class KnownKeywords - { - public const string SHADER = "shader"; - public const string PROPERTIES = "properties"; - public const string PIPELINE = "pipeline"; - public const string PASS = "pass"; - public const string DEFINES = "defines"; - public const string KEYWORDS = "keywords"; - public const string INCLUDES = "includes"; - public const string GLOBAL = "global"; - public const string LOCAL = "local"; - } - - public static class KnownPipelineProperties - { - public const string ZTEST = "ztest"; - public const string ZWRITE = "zwrite"; - public const string CULL = "cull"; - public const string BLEND = "blend"; - public const string COLORMASK = "color_mask"; - } - - public static class KnownFunctions - { - public const string TASK_SHADER = "ts"; - public const string MESH_SHADER = "ms"; - public const string PIXEL_SHADER = "ps"; - public const string COMPUTE_SHADER = "cs"; - public const string LOCAL = "local"; - public const string GLOBAL = "global"; - public const string FALLBACK = "fallback"; - } - - public static class KnownTypes - { - // Basic types - public const string FLOAT = "float"; - public const string FLOAT2 = "float2"; - public const string FLOAT3 = "float3"; - public const string FLOAT4 = "float4"; - public const string FLOAT4X4 = "float4x4"; - - public const string INT = "int"; - public const string INT2 = "int2"; - public const string INT3 = "int3"; - public const string INT4 = "int4"; - - public const string UINT = "uint"; - public const string UINT2 = "uint2"; - public const string UINT3 = "uint3"; - public const string UINT4 = "uint4"; - - public const string BOOL = "bool"; - public const string BOOL2 = "bool2"; - public const string BOOL3 = "bool3"; - public const string BOOL4 = "bool4"; - - // Texture types - public const string TEXTURE2D = "tex2d"; - public const string TEXTURE2D_ARRAY = "tex2d_arr"; - public const string TEXTURE3D = "tex3d"; - public const string TEXTURECUBE = "texcube"; - public const string TEXTURECUBE_ARRAY = "texcube_arr"; - - public const string SAMPLER = "sampler"; - } - - public static class KnownTextureValue - { - public const string WHITE = "white"; - public const string BLACK = "black"; - public const string GREY = "grey"; - public const string NORMAL = "normal"; - public const string TRANSPARENT = "transparent"; - } - - private static readonly HashSet s_keywords = new() - { - KnownKeywords.SHADER, - KnownKeywords.PROPERTIES, - KnownKeywords.PIPELINE, - KnownKeywords.PASS, - KnownKeywords.DEFINES, - KnownKeywords.KEYWORDS, - KnownKeywords.INCLUDES, - KnownKeywords.GLOBAL, - KnownKeywords.LOCAL, - }; - - private static readonly HashSet s_functions = new() - { - KnownFunctions.TASK_SHADER, - KnownFunctions.PIXEL_SHADER, - KnownFunctions.MESH_SHADER, - KnownFunctions.COMPUTE_SHADER, - KnownFunctions.LOCAL, - KnownFunctions.GLOBAL, - }; - - private static readonly HashSet s_types = new() - { - KnownTypes.FLOAT, KnownTypes.FLOAT2, KnownTypes.FLOAT3, KnownTypes.FLOAT4, KnownTypes.FLOAT4X4, - KnownTypes.INT, KnownTypes.INT2, KnownTypes.INT3, KnownTypes.INT4, - KnownTypes.UINT, KnownTypes.UINT2, KnownTypes.UINT3, KnownTypes.UINT4, - KnownTypes.BOOL, KnownTypes.BOOL2, KnownTypes.BOOL3, KnownTypes.BOOL4, - KnownTypes.TEXTURE2D, KnownTypes.TEXTURE2D_ARRAY, KnownTypes.TEXTURE3D, - KnownTypes.TEXTURECUBE, KnownTypes.TEXTURECUBE_ARRAY, - KnownTypes.SAMPLER, - }; - - private static readonly HashSet s_textureDefaultValues = new() - { - KnownTextureValue.WHITE, - KnownTextureValue.BLACK, - KnownTextureValue.GREY, - KnownTextureValue.NORMAL, - KnownTextureValue.TRANSPARENT, - }; - - public static bool IsKeyword(string lexeme) => s_keywords.Contains(lexeme); - - public static bool IsFunction(string lexeme) => s_functions.Contains(lexeme); - - public static bool IsType(string lexeme) => s_types.Contains(lexeme); - - public static bool IsTextureDefaultValue(string lexeme) => s_textureDefaultValues.Contains(lexeme); -} diff --git a/Ghost.DSL/ShaderCompiler/TokenStream.cs b/Ghost.DSL/ShaderCompiler/TokenStream.cs deleted file mode 100644 index 6b10248..0000000 --- a/Ghost.DSL/ShaderCompiler/TokenStream.cs +++ /dev/null @@ -1,321 +0,0 @@ -namespace Ghost.DSL.ShaderCompiler; - -internal static class TokenStreamImple -{ - public static Token Peek(ReadOnlySpan tokens, int index, int length) - { - if (index + length < tokens.Length) - { - return tokens[index + length]; - } - - throw new IndexOutOfRangeException(); - } - - public static bool TryPeek(ReadOnlySpan tokens, int index, int length, out Token token) - { - if (index + length < tokens.Length) - { - token = tokens[index + length]; - return true; - } - - token = default; - return false; - } - - public static bool TryConsume(ReadOnlySpan tokens, ref int index, out Token token) - { - if (index < tokens.Length) - { - token = tokens[index++]; - return true; - } - - token = default; - return false; - } - - public static Token Consume(ReadOnlySpan tokens, ref int index, int count = 1) - { - if (index + count <= tokens.Length) - { - index += count; - return tokens[index - 1]; - } - - throw new IndexOutOfRangeException(); - } - - public static bool Match(ReadOnlySpan tokens, int index, TokenType type, string? lexeme) - { - var t = Peek(tokens, index, 0); - if (!t.Match(type, lexeme)) - { - return false; - } - - return true; - } - - public static int MatchMany(ReadOnlySpan tokens, int index, TokenType type, string? lexeme) - { - var count = 0; - while (TryPeek(tokens, index, 0, out var t) && t.Match(type, lexeme)) - { - count++; - } - - return count; - } - - public static Token Expect(ReadOnlySpan tokens, ref int index, TokenType type, string? lexeme) - { - if (!TryPeek(tokens, index, 0, out var t)) - { - throw new InvalidOperationException("Expected token but reached end of stream"); - } - - if (!t.Match(type, lexeme)) - { - throw new InvalidOperationException($"Expected token {type}('{lexeme ?? "*"}') but got {t}"); - } - - index++; - return t; - } -} - -internal class TokenStream -{ - private readonly Token[] _tokens; - private int _index = 0; - - public int Length => _tokens.Length; - public int Remaining => _tokens.Length - _index; - public bool HasMore => _index < _tokens.Length; - public int Position - { - get => _index; - set - { - if (value < 0 || value > _tokens.Length) - { - throw new ArgumentOutOfRangeException(nameof(value), "Position must be within the bounds of the token stream."); - } - _index = value; - } - } - - public TokenStream(Token[] tokens) - { - _tokens = tokens; - } - - public TokenStream(IEnumerable tokens) - { - _tokens = tokens.ToArray(); - } - - public Token Peek(int length = 0) - { - return TokenStreamImple.Peek(_tokens, _index, length); - } - - public bool TryPeek(out Token token) - { - return TokenStreamImple.TryPeek(_tokens, _index, 0, out token); - } - - public bool TryPeek(int length, out Token token) - { - return TokenStreamImple.TryPeek(_tokens, _index, length, out token); - } - - public bool TryConsume(out Token token) - { - return TokenStreamImple.TryConsume(_tokens, ref _index, out token); - } - - public Token Consume(int count = 1) - { - return TokenStreamImple.Consume(_tokens, ref _index, count); - } - - public bool Match(TokenType type, string? lexeme = null) - { - return TokenStreamImple.Match(_tokens, _index, type, lexeme); - } - - public int MatchMany(TokenType type, string? lexeme = null) - { - return TokenStreamImple.MatchMany(_tokens, _index, type, lexeme); - } - - public Token Expect(TokenType type, string? lexeme = null) - { - return TokenStreamImple.Expect(_tokens, ref _index, type, lexeme); - } - - public TokenStreamSlice Slice(int length = -1) - { - if (length <= 0) - { - length = _tokens.Length - _index; - } - - var slice = _tokens.AsSpan().Slice(_index, length); - _index += length; - return new TokenStreamSlice(slice); - } - - public TokenStreamSlice SliceNextBlock() - { - var length = 0; - var lBraceCount = 0; - var rBraceCount = 0; - - Token nextToken; - - do - { - nextToken = Peek(length); - - if (length > 0 && lBraceCount > 0 && lBraceCount == rBraceCount) - { - break; - } - - if (nextToken.Match(TokenType.LBrace)) - { - lBraceCount++; - } - else if (nextToken.Match(TokenType.RBrace)) - { - rBraceCount++; - } - - length++; - } - while (_index + length < _tokens.Length); - - return Slice(length); - } -} - -internal ref struct TokenStreamSlice -{ - private readonly ReadOnlySpan _tokens; - private int _index; - - public readonly int Length => _tokens.Length; - public readonly int Remaining => _tokens.Length - _index; - public readonly bool HasMore => _index < _tokens.Length; - - public int Position - { - readonly get => _index; - set - { - if (value < 0 || value > _tokens.Length) - { - throw new ArgumentOutOfRangeException(nameof(value), "Position must be within the bounds of the token stream."); - } - _index = value; - } - } - - internal TokenStreamSlice(ReadOnlySpan tokens) - { - _tokens = tokens; - _index = 0; - } - - public Token Peek(int length = 0) - { - return TokenStreamImple.Peek(_tokens, _index, length); - } - - public bool TryPeek(out Token token) - { - return TokenStreamImple.TryPeek(_tokens, _index, 0, out token); - } - - public bool TryPeek(int length, out Token token) - { - return TokenStreamImple.TryPeek(_tokens, _index, length, out token); - } - - public bool TryConsume(out Token token) - { - return TokenStreamImple.TryConsume(_tokens, ref _index, out token); - } - - public Token Consume(int count = 1) - { - return TokenStreamImple.Consume(_tokens, ref _index, count); - } - - public bool Match(TokenType type, string? lexeme = null) - { - return TokenStreamImple.Match(_tokens, _index, type, lexeme); - } - - public int MatchMany(TokenType type, string? lexeme = null) - { - return TokenStreamImple.MatchMany(_tokens, _index, type, lexeme); - } - - public Token Expect(TokenType type, string? lexeme = null) - { - return TokenStreamImple.Expect(_tokens, ref _index, type, lexeme); - } - - public TokenStreamSlice Slice(int length = -1) - { - if (length <= 0) - { - length = _tokens.Length - _index; - } - - var slice = _tokens.Slice(_index, length); - _index += length; - return new TokenStreamSlice(slice); - } - - public TokenStreamSlice SliceNextBlock() - { - var length = 0; - var lBraceCount = 0; - var rBraceCount = 0; - - do - { - var nextToken = Peek(length); - - if (length > 0 && lBraceCount > 0 && lBraceCount == rBraceCount) - { - break; - } - - if (nextToken.Match(TokenType.LBrace)) - { - lBraceCount++; - } - else if (nextToken.Match(TokenType.RBrace)) - { - rBraceCount++; - } - - length++; - } - while (_index + length < _tokens.Length); - - if (lBraceCount != rBraceCount) - { - throw new InvalidOperationException("Unmatched braces in token stream."); - } - - return Slice(length); - } -} diff --git a/Ghost.DSL/ShaderParser/AntlrShaderCompiler.cs b/Ghost.DSL/ShaderParser/AntlrShaderCompiler.cs new file mode 100644 index 0000000..8ab875c --- /dev/null +++ b/Ghost.DSL/ShaderParser/AntlrShaderCompiler.cs @@ -0,0 +1,383 @@ +using Antlr4.Runtime; +using Ghost.Core.Graphics; +using Ghost.DSL.ShaderCompiler; +using Ghost.DSL.ShaderParser.Model; + +namespace Ghost.DSL.ShaderParser; + +public class AntlrShaderCompiler +{ + public static List ParseShaders(string source, out List errors) + { + errors = new List(); + + try + { + var inputStream = new AntlrInputStream(source); + var lexer = new GhostShaderLexer(inputStream); + + // Capture lexer errors + lexer.RemoveErrorListeners(); + var lexerErrorListener = new ErrorListener(errors); + lexer.AddErrorListener(lexerErrorListener); + + var tokenStream = new CommonTokenStream(lexer); + var parser = new GhostShaderParser(tokenStream); + + // Capture parser errors + parser.RemoveErrorListeners(); + var parserErrorListener = new ErrorListener(errors); + parser.AddErrorListener(parserErrorListener); + + var tree = parser.shaderFile(); + + if (errors.Count > 0) + { + return new List(); + } + + var visitor = new ShaderVisitor(); + visitor.Visit(tree); + + return visitor.Shaders; + } + catch (Exception ex) + { + errors.Add(new DSLShaderError + { + message = $"Unexpected error during parsing: {ex.Message}", + line = -1, + column = -1 + }); + return new List(); + } + } + + public static DSLShaderSemantics? ConvertToSemantics(ShaderModel model, out List errors) + { + errors = new List(); + + if (string.IsNullOrWhiteSpace(model.Name)) + { + errors.Add(new DSLShaderError + { + message = "Shader name cannot be empty.", + line = 0, + column = 0 + }); + return null; + } + + var semantics = new DSLShaderSemantics + { + name = model.Name, + properties = ConvertProperties(model.Properties, errors), + pipeline = ConvertPipeline(model.Pipeline, errors) + }; + + foreach (var pass in model.Passes) + { + var passSemantic = ConvertPass(pass, errors); + if (passSemantic != null) + { + semantics.passes ??= new List(); + semantics.passes.Add(passSemantic); + } + } + + return semantics; + } + + private static List? ConvertProperties(PropertiesBlockModel? properties, List errors) + { + if (properties == null || properties.Properties.Count == 0) + { + return null; + } + + var result = new List(); + var usedNames = new HashSet(); + + foreach (var prop in properties.Properties) + { + if (usedNames.Contains(prop.Name)) + { + errors.Add(new DSLShaderError + { + message = $"Duplicate property name '{prop.Name}'.", + line = 0, + column = 0 + }); + continue; + } + + var semantic = new PropertySemantic + { + name = prop.Name, + scope = prop.Scope?.ToLower() == "global" ? PropertyScope.Global : PropertyScope.Local, + type = ParsePropertyType(prop.Type, errors) + }; + + if (prop.Initializer.Count > 0) + { + semantic.defaultValue = ParsePropertyValue(semantic.type, prop.Initializer, errors); + } + + usedNames.Add(prop.Name); + result.Add(semantic); + } + + return result; + } + + private static ShaderPropertyType ParsePropertyType(string type, List errors) + { + return type.ToLower() switch + { + "float" => ShaderPropertyType.Float, + "float2" => ShaderPropertyType.Float2, + "float3" => ShaderPropertyType.Float3, + "float4" => ShaderPropertyType.Float4, + "float4x4" => ShaderPropertyType.Float4x4, + "int" => ShaderPropertyType.Int, + "int2" => ShaderPropertyType.Int2, + "int3" => ShaderPropertyType.Int3, + "int4" => ShaderPropertyType.Int4, + "uint" => ShaderPropertyType.UInt, + "uint2" => ShaderPropertyType.UInt2, + "uint3" => ShaderPropertyType.UInt3, + "uint4" => ShaderPropertyType.UInt4, + "bool" => ShaderPropertyType.Bool, + "bool2" => ShaderPropertyType.Bool2, + "bool3" => ShaderPropertyType.Bool3, + "bool4" => ShaderPropertyType.Bool4, + "tex2d" => ShaderPropertyType.Texture2D, + "tex3d" => ShaderPropertyType.Texture3D, + "texcube" => ShaderPropertyType.TextureCube, + "texcube_arr" => ShaderPropertyType.TextureCubeArray, + "tex2d_arr" => ShaderPropertyType.Texture2DArray, + "sampler" => ShaderPropertyType.Sampler, + _ => ShaderPropertyType.None + }; + } + + private static object? ParsePropertyValue(ShaderPropertyType type, List values, List errors) + { + // For textures, the value is an identifier (e.g., "white", "black") + if (type is ShaderPropertyType.Texture2D or ShaderPropertyType.Texture3D or ShaderPropertyType.TextureCube) + { + return values.Count > 0 ? values[0] : null; + } + + // For samplers, no default value + if (type == ShaderPropertyType.Sampler) + { + return null; + } + + // For numeric types, parse the values + try + { + return type switch + { + ShaderPropertyType.Float => values.Count > 0 ? float.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture) : 0f, + ShaderPropertyType.Float2 => values.Count >= 2 ? new Misaki.HighPerformance.Mathematics.float2( + float.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.Float3 => values.Count >= 3 ? new Misaki.HighPerformance.Mathematics.float3( + float.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[2], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.Float4 => values.Count >= 4 ? new Misaki.HighPerformance.Mathematics.float4( + float.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[2], System.Globalization.CultureInfo.InvariantCulture), + float.Parse(values[3], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.Int => values.Count > 0 ? int.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture) : 0, + ShaderPropertyType.Int2 => values.Count >= 2 ? new Misaki.HighPerformance.Mathematics.int2( + int.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.Int3 => values.Count >= 3 ? new Misaki.HighPerformance.Mathematics.int3( + int.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[2], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.Int4 => values.Count >= 4 ? new Misaki.HighPerformance.Mathematics.int4( + int.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[1], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[2], System.Globalization.CultureInfo.InvariantCulture), + int.Parse(values[3], System.Globalization.CultureInfo.InvariantCulture)) : default, + ShaderPropertyType.UInt => values.Count > 0 ? uint.Parse(values[0], System.Globalization.CultureInfo.InvariantCulture) : 0u, + ShaderPropertyType.Bool => values.Count > 0 && (values[0] == "1" || values[0].ToLower() == "true"), + _ => null + }; + } + catch (Exception ex) + { + errors.Add(new DSLShaderError + { + message = $"Failed to parse property value: {ex.Message}", + line = 0, + column = 0 + }); + return null; + } + } + + private static PipelineSemantic? ConvertPipeline(PipelineBlockModel? pipeline, List errors) + { + if (pipeline == null || pipeline.Statements.Count == 0) + { + return null; + } + + var semantic = new PipelineSemantic(); + + foreach (var (key, value) in pipeline.Statements) + { + switch (key.ToLower()) + { + case "ztest": + semantic.zTest = value.ToLower() switch + { + "disabled" => ZTest.Disabled, + "less" => ZTest.Less, + "lessequal" => ZTest.LessEqual, + "equal" => ZTest.Equal, + "greaterequal" => ZTest.GreaterEqual, + "greater" => ZTest.Greater, + "notequal" => ZTest.NotEqual, + "always" => ZTest.Always, + _ => ZTest.Disabled + }; + break; + case "zwrite": + semantic.zWrite = value.ToLower() == "on" ? ZWrite.On : ZWrite.Off; + break; + case "cull": + semantic.cull = value.ToLower() switch + { + "off" => Cull.Off, + "front" => Cull.Front, + "back" => Cull.Back, + _ => Cull.Off + }; + break; + case "blend": + semantic.blend = value.ToLower() switch + { + "opaque" => Blend.Opaque, + "alpha" => Blend.Alpha, + "additive" => Blend.Additive, + "multiply" => Blend.Multiply, + "premultipliedalpha" => Blend.PremultipliedAlpha, + _ => Blend.Opaque + }; + break; + case "color_mask": + semantic.colorMask = value.ToLower() == "all" ? ColorWriteMask.All : ColorWriteMask.None; + break; + } + } + + return semantic; + } + + private static PassSemantic? ConvertPass(PassBlockModel pass, List errors) + { + var semantic = new PassSemantic + { + name = pass.Name, + hlsl = pass.Hlsl?.Code, + defines = pass.Defines?.Defines, + includes = pass.Includes?.Includes, + localPipeline = ConvertPipeline(pass.LocalPipeline, errors) + }; + + if (pass.Keywords != null) + { + semantic.keywords = new List(); + foreach (var group in pass.Keywords.Groups) + { + var keywordGroup = new KeywordsGroup + { + space = group.Scope?.ToLower() == "global" ? KeywordSpace.Global : KeywordSpace.Local, + keywords = group.Keywords + }; + semantic.keywords.Add(keywordGroup); + } + } + + foreach (var entry in pass.ShaderEntries) + { + var entryType = entry.EntryType.ToLower(); + var shaderEntry = new ShaderEntryPoint + { + shader = entry.ShaderPath, + entry = entry.EntryPoint + }; + + switch (entryType) + { + case "mesh" or "ms": + semantic.meshShader = shaderEntry; + break; + case "pixel" or "ps": + semantic.pixelShader = shaderEntry; + break; + case "task" or "ts": + semantic.taskShader = shaderEntry; + break; + default: + errors.Add(new DSLShaderError + { + message = $"Unknown shader entry type '{entry.EntryType}'.", + line = 0, + column = 0 + }); + break; + } + } + + if (semantic.meshShader.shader == null || semantic.pixelShader.shader == null) + { + errors.Add(new DSLShaderError + { + message = $"Pass '{pass.Name}' must contain a mesh/ms shader and a pixel/ps shader declaration.", + line = 0, + column = 0 + }); + } + + return semantic; + } + + private class ErrorListener : BaseErrorListener, IAntlrErrorListener, IAntlrErrorListener + { + private readonly List _errors; + + public ErrorListener(List errors) + { + _errors = errors; + } + + public void SyntaxError(TextWriter output, IRecognizer recognizer, int offendingSymbol, int line, int charPositionInLine, string msg, RecognitionException e) + { + _errors.Add(new DSLShaderError + { + message = msg, + line = line, + column = charPositionInLine + }); + } + + public new void SyntaxError(TextWriter output, IRecognizer recognizer, IToken offendingSymbol, int line, int charPositionInLine, string msg, RecognitionException e) + { + _errors.Add(new DSLShaderError + { + message = msg, + line = line, + column = charPositionInLine + }); + } + } +} diff --git a/Ghost.DSL/ShaderParser/Model/ShaderModel.cs b/Ghost.DSL/ShaderParser/Model/ShaderModel.cs new file mode 100644 index 0000000..bb55d3f --- /dev/null +++ b/Ghost.DSL/ShaderParser/Model/ShaderModel.cs @@ -0,0 +1,78 @@ +namespace Ghost.DSL.ShaderParser.Model; + +public class ShaderModel +{ + public string Name { get; set; } = string.Empty; + public PropertiesBlockModel? Properties { get; set; } + public PipelineBlockModel? Pipeline { get; set; } + public List Passes { get; set; } = new(); + public List FunctionCalls { get; set; } = new(); +} + +public class PropertiesBlockModel +{ + public List Properties { get; set; } = new(); +} + +public class PropertyDeclarationModel +{ + public string? Scope { get; set; } + public string Type { get; set; } = string.Empty; + public string Name { get; set; } = string.Empty; + public List Initializer { get; set; } = new(); +} + +public class PipelineBlockModel +{ + public Dictionary Statements { get; set; } = new(); +} + +public class PassBlockModel +{ + public string Name { get; set; } = string.Empty; + public PipelineBlockModel? LocalPipeline { get; set; } + public DefinesBlockModel? Defines { get; set; } + public IncludesBlockModel? Includes { get; set; } + public KeywordsBlockModel? Keywords { get; set; } + public HlslBlockModel? Hlsl { get; set; } + public List ShaderEntries { get; set; } = new(); +} + +public class DefinesBlockModel +{ + public List Defines { get; set; } = new(); +} + +public class IncludesBlockModel +{ + public List Includes { get; set; } = new(); +} + +public class KeywordsBlockModel +{ + public List Groups { get; set; } = new(); +} + +public class KeywordGroupModel +{ + public string? Scope { get; set; } + public List Keywords { get; set; } = new(); +} + +public class HlslBlockModel +{ + public string Code { get; set; } = string.Empty; +} + +public class ShaderEntryModel +{ + public string EntryType { get; set; } = string.Empty; // "mesh", "pixel", "task", etc. + public string ShaderPath { get; set; } = string.Empty; + public string EntryPoint { get; set; } = string.Empty; +} + +public class FunctionCallModel +{ + public string Name { get; set; } = string.Empty; + public List Arguments { get; set; } = new(); +} diff --git a/Ghost.DSL/ShaderParser/ShaderVisitor.cs b/Ghost.DSL/ShaderParser/ShaderVisitor.cs new file mode 100644 index 0000000..34f13cd --- /dev/null +++ b/Ghost.DSL/ShaderParser/ShaderVisitor.cs @@ -0,0 +1,261 @@ +using Antlr4.Runtime.Misc; +using Ghost.DSL.ShaderParser.Model; + +namespace Ghost.DSL.ShaderParser; + +public class ShaderVisitor : GhostShaderParserBaseVisitor +{ + public List Shaders { get; } = new(); + + public override object VisitShaderFile([NotNull] GhostShaderParser.ShaderFileContext context) + { + foreach (var shaderContext in context.shader()) + { + var shader = (ShaderModel)VisitShader(shaderContext); + Shaders.Add(shader); + } + return Shaders; + } + + public override object VisitShader([NotNull] GhostShaderParser.ShaderContext context) + { + var shader = new ShaderModel + { + Name = StripQuotes(context.STRING_LITERAL().GetText()) + }; + + var shaderBody = context.shaderBody(); + if (shaderBody != null) + { + foreach (var propBlock in shaderBody.propertiesBlock()) + { + shader.Properties = (PropertiesBlockModel)VisitPropertiesBlock(propBlock); + } + + foreach (var pipelineBlock in shaderBody.pipelineBlock()) + { + shader.Pipeline = (PipelineBlockModel)VisitPipelineBlock(pipelineBlock); + } + + foreach (var passBlock in shaderBody.passBlock()) + { + shader.Passes.Add((PassBlockModel)VisitPassBlock(passBlock)); + } + + foreach (var funcCall in shaderBody.functionCall()) + { + shader.FunctionCalls.Add((FunctionCallModel)VisitFunctionCall(funcCall)); + } + } + + return shader; + } + + public override object VisitPropertiesBlock([NotNull] GhostShaderParser.PropertiesBlockContext context) + { + var properties = new PropertiesBlockModel(); + + foreach (var propDecl in context.propertyDeclaration()) + { + properties.Properties.Add((PropertyDeclarationModel)VisitPropertyDeclaration(propDecl)); + } + + return properties; + } + + public override object VisitPropertyDeclaration([NotNull] GhostShaderParser.PropertyDeclarationContext context) + { + var property = new PropertyDeclarationModel + { + Type = context.IDENTIFIER(0).GetText(), + Name = context.IDENTIFIER(1).GetText() + }; + + if (context.scope() != null) + { + property.Scope = context.scope().GetText(); + } + + if (context.propertyInitializer() != null) + { + var init = context.propertyInitializer(); + foreach (var number in init.NUMBER()) + { + property.Initializer.Add(number.GetText()); + } + foreach (var identifier in init.IDENTIFIER()) + { + property.Initializer.Add(identifier.GetText()); + } + } + + return property; + } + + public override object VisitPipelineBlock([NotNull] GhostShaderParser.PipelineBlockContext context) + { + var pipeline = new PipelineBlockModel(); + + foreach (var statement in context.pipelineStatement()) + { + var key = statement.IDENTIFIER(0).GetText(); + var value = statement.IDENTIFIER(1).GetText(); + pipeline.Statements[key] = value; + } + + return pipeline; + } + + public override object VisitPassBlock([NotNull] GhostShaderParser.PassBlockContext context) + { + var pass = new PassBlockModel + { + Name = StripQuotes(context.STRING_LITERAL().GetText()) + }; + + var passBody = context.passBody(); + if (passBody != null) + { + foreach (var definesBlock in passBody.definesBlock()) + { + pass.Defines = (DefinesBlockModel)VisitDefinesBlock(definesBlock); + } + + foreach (var includesBlock in passBody.includesBlock()) + { + pass.Includes = (IncludesBlockModel)VisitIncludesBlock(includesBlock); + } + + foreach (var keywordsBlock in passBody.keywordsBlock()) + { + pass.Keywords = (KeywordsBlockModel)VisitKeywordsBlock(keywordsBlock); + } + + foreach (var pipelineBlock in passBody.pipelineBlock()) + { + pass.LocalPipeline = (PipelineBlockModel)VisitPipelineBlock(pipelineBlock); + } + + foreach (var hlslBlock in passBody.hlslBlock()) + { + pass.Hlsl = (HlslBlockModel)VisitHlslBlock(hlslBlock); + } + + foreach (var shaderEntry in passBody.shaderEntry()) + { + pass.ShaderEntries.Add((ShaderEntryModel)VisitShaderEntry(shaderEntry)); + } + } + + return pass; + } + + public override object VisitDefinesBlock([NotNull] GhostShaderParser.DefinesBlockContext context) + { + var defines = new DefinesBlockModel(); + + foreach (var defineStmt in context.defineStatement()) + { + defines.Defines.Add(defineStmt.IDENTIFIER().GetText()); + } + + return defines; + } + + public override object VisitIncludesBlock([NotNull] GhostShaderParser.IncludesBlockContext context) + { + var includes = new IncludesBlockModel(); + + foreach (var includeStmt in context.includeStatement()) + { + includes.Includes.Add(StripQuotes(includeStmt.STRING_LITERAL().GetText())); + } + + return includes; + } + + public override object VisitKeywordsBlock([NotNull] GhostShaderParser.KeywordsBlockContext context) + { + var keywords = new KeywordsBlockModel(); + + foreach (var keywordStmt in context.keywordStatement()) + { + var group = new KeywordGroupModel(); + + if (keywordStmt.scope() != null) + { + group.Scope = keywordStmt.scope().GetText(); + } + + foreach (var identifier in keywordStmt.IDENTIFIER()) + { + group.Keywords.Add(identifier.GetText()); + } + + keywords.Groups.Add(group); + } + + return keywords; + } + + public override object VisitHlslBlock([NotNull] GhostShaderParser.HlslBlockContext context) + { + var hlsl = new HlslBlockModel(); + + // Get the text between the braces + var start = context.LBRACE().Symbol.StopIndex + 1; + var stop = context.RBRACE().Symbol.StartIndex - 1; + + if (stop >= start) + { + var input = context.Start.InputStream; + hlsl.Code = input.GetText(new Antlr4.Runtime.Misc.Interval(start, stop)); + } + + return hlsl; + } + + public override object VisitShaderEntry([NotNull] GhostShaderParser.ShaderEntryContext context) + { + var entry = new ShaderEntryModel + { + EntryType = context.IDENTIFIER().GetText(), + ShaderPath = StripQuotes(context.STRING_LITERAL(0).GetText()), + EntryPoint = StripQuotes(context.STRING_LITERAL(1).GetText()) + }; + + return entry; + } + + public override object VisitFunctionCall([NotNull] GhostShaderParser.FunctionCallContext context) + { + var funcCall = new FunctionCallModel + { + Name = context.IDENTIFIER().GetText() + }; + + if (context.functionArguments() != null) + { + foreach (var arg in context.functionArguments().functionArgument()) + { + var text = arg.GetText(); + if (text.StartsWith('"')) + { + text = StripQuotes(text); + } + funcCall.Arguments.Add(text); + } + } + + return funcCall; + } + + private static string StripQuotes(string text) + { + if (text.Length >= 2 && text.StartsWith('"') && text.EndsWith('"')) + { + return text.Substring(1, text.Length - 2); + } + return text; + } +} diff --git a/Ghost.Entities.Test/EntityQueryTest.cs b/Ghost.Entities.Test/EntityQueryTest.cs index a78fb78..a28ee6b 100644 --- a/Ghost.Entities.Test/EntityQueryTest.cs +++ b/Ghost.Entities.Test/EntityQueryTest.cs @@ -48,7 +48,7 @@ public partial class EntityQueryTest : ITest _world.EntityManager.CreateEntities(entities, set); var queryID = new QueryBuilder().WithAllRW().Build(_world); - ref var query = ref _world.GetEntityQueryReference(queryID); + ref var query = ref _world.ComponentManager.GetEntityQueryReference(queryID); _world.AdvanceVersion(); diff --git a/Ghost.Entities.Test/SerializationTest.cs b/Ghost.Entities.Test/SerializationTest.cs index 14605ab..5fcd99e 100644 --- a/Ghost.Entities.Test/SerializationTest.cs +++ b/Ghost.Entities.Test/SerializationTest.cs @@ -40,9 +40,9 @@ public class SerializationTest : ITest writer.WriteString("Name", "world 1"); writer.WriteStartArray("Entities"); - for (var i = 0; i < _world.ArchetypeCount; i++) + for (var i = 0; i < _world.ComponentManager.ArchetypeCount; i++) { - ref var archetype = ref _world.GetArchetypeReference(i); + ref var archetype = ref _world.ComponentManager.GetArchetypeReference(i); for (var j = 0; j < archetype.ChunkCount; j++) { diff --git a/Ghost.Graphics/Contracts/IShaderCompiler.cs b/Ghost.Graphics/Contracts/IShaderCompiler.cs index 83d350c..cffac20 100644 --- a/Ghost.Graphics/Contracts/IShaderCompiler.cs +++ b/Ghost.Graphics/Contracts/IShaderCompiler.cs @@ -39,6 +39,7 @@ public ref struct ShaderCompilationConfig public ReadOnlySpan includes; public string shaderPath; public string entryPoint; + public string? injectedCode; public ShaderStage stage; public CompilerTier tier; public CompilerOptimizeLevel optimizeLevel; diff --git a/Ghost.Graphics/Core/DxcShaderCompiler.cs b/Ghost.Graphics/Core/DxcShaderCompiler.cs index a69ed3a..cc46e5c 100644 --- a/Ghost.Graphics/Core/DxcShaderCompiler.cs +++ b/Ghost.Graphics/Core/DxcShaderCompiler.cs @@ -89,23 +89,45 @@ internal sealed partial class DxcShaderCompiler return argsArray; } - private static Result GetFinalShaderCode(string shaderPath, ReadOnlySpan includes) + private static Result GetFinalShaderCode(string shaderPath, ReadOnlySpan includes, string? injectedCode) { - if (!File.Exists(shaderPath)) + string shaderCode; + if (shaderPath == "hlsl_block") { - return ErrorStatus.NotFound; - } + if (string.IsNullOrEmpty(injectedCode)) + { + return ErrorStatus.InvalidArgument; + } - var shaderCode = File.ReadAllText(shaderPath); + shaderCode = string.Empty; + } + else + { + if (!File.Exists(shaderPath)) + { + return ErrorStatus.NotFound; + } + + shaderCode = File.ReadAllText(shaderPath); + } var sb = new System.Text.StringBuilder(); foreach (var includePath in includes) { sb.AppendLine($"#include \"{includePath}\""); } + + if (!string.IsNullOrEmpty(injectedCode)) + { + sb.AppendLine($"#line 1 \"hlsl_block\""); + sb.AppendLine(injectedCode); + } - sb.AppendLine($"#line {includes.Length + 1} \"{shaderPath}\""); - sb.AppendLine(shaderCode); + if (!string.IsNullOrEmpty(shaderCode)) + { + sb.AppendLine($"#line 1 \"{shaderPath}\""); + sb.AppendLine(shaderCode); + } return sb.ToString(); } @@ -264,15 +286,7 @@ internal sealed unsafe partial class DxcShaderCompiler : IShaderCompiler ThrowIfFailed(_utils.Get()->CreateDefaultIncludeHandler(includeHandler.GetAddressOf())); - // Create source blob - // fixed (char* pPath = config.shaderPath) - // { - // if (_utils.Get()->LoadFile(pPath, null, sourceBlob.GetAddressOf()).FAILED) - // { - // return Result.Failure($"Failed to load shader file: {config.shaderPath}"); - // } - // } - var finalShaderCodeResult = GetFinalShaderCode(config.shaderPath, config.includes); + var finalShaderCodeResult = GetFinalShaderCode(config.shaderPath, config.includes, config.injectedCode); if (finalShaderCodeResult.IsFailure) { return Result.Failure(finalShaderCodeResult.Error); @@ -386,6 +400,7 @@ internal sealed unsafe partial class DxcShaderCompiler : IShaderCompiler includes = descriptor.includes.AsSpan(), shaderPath = tsEntry.shader, entryPoint = tsEntry.entry, + injectedCode = descriptor.hlsl + additionalConfig.injectedCode, stage = ShaderStage.TaskShader, tier = additionalConfig.tier, optimizeLevel = additionalConfig.optimizeLevel, @@ -411,6 +426,7 @@ internal sealed unsafe partial class DxcShaderCompiler : IShaderCompiler includes = descriptor.includes.AsSpan(), shaderPath = msEntry.shader, entryPoint = msEntry.entry, + injectedCode = descriptor.hlsl + additionalConfig.injectedCode, stage = ShaderStage.MeshShader, tier = additionalConfig.tier, optimizeLevel = additionalConfig.optimizeLevel, @@ -440,6 +456,7 @@ internal sealed unsafe partial class DxcShaderCompiler : IShaderCompiler includes = descriptor.includes.AsSpan(), shaderPath = psEntry.shader, entryPoint = psEntry.entry, + injectedCode = descriptor.hlsl + additionalConfig.injectedCode, stage = ShaderStage.PixelShader, tier = additionalConfig.tier, optimizeLevel = additionalConfig.optimizeLevel, diff --git a/Ghost.Graphics/test.gsdef b/Ghost.Graphics/test.gsdef index 7de2a28..885ef69 100644 --- a/Ghost.Graphics/test.gsdef +++ b/Ghost.Graphics/test.gsdef @@ -21,20 +21,6 @@ shader "MyShader/Standard" color_mask = all; } - keywords - { - local TEST_KEYWORD, TEST_KEYWORD2; - local TEST_KEYWORD3; - } - - hlsl - { - float Test() - { - return 1.0; - } - } - mesh "F:/csharp/GhostEngine/Ghost.Graphics/RenderPasses/ShaderCode.hlsl" : "MSMain"; pixel "F:/csharp/GhostEngine/Ghost.Graphics/RenderPasses/ShaderCode.hlsl" : "PSMain"; } diff --git a/Ghost.RenderGraph.Concept/ALIASING.md b/Ghost.RenderGraph.Concept/ALIASING.md deleted file mode 100644 index 179e43b..0000000 --- a/Ghost.RenderGraph.Concept/ALIASING.md +++ /dev/null @@ -1,177 +0,0 @@ -# Resource Aliasing in Render Graph - -## Overview - -Resource aliasing is a memory optimization technique where multiple virtual resources share the same physical memory allocation. This significantly reduces memory usage for transient resources. - -## How It Works - -### 1. Lifetime Analysis -The render graph analyzes when each transient resource is first used and last used: -``` -GBuffer.Albedo: [0..1] ━━━━━━━━ -SSAO: [2..4] ━━━━━━━━━━━ -``` - -### 2. Aliasing Detection -Resources with non-overlapping lifetimes can share memory: -``` -Physical_Texture_2: - [0..1] GBuffer.Albedo ━━━━━━━━ - [2..4] SSAO ━━━━━━━━━━━ ← ALIAS! -``` - -### 3. Memory Allocation -Instead of creating 2 separate 8MB textures (16MB total), we create 1 physical allocation (8MB) that both virtual resources map to. - -## Aliasing Barriers - -In D3D12/Vulkan, when you reuse memory for a different resource, you must insert an **aliasing barrier** to inform the GPU that the memory interpretation has changed. - -### When Aliasing Barriers Are Needed - -An aliasing barrier is required when: -1. Two or more resources share the same physical memory -2. You're switching from one resource to another -3. Both resources are accessed within overlapping command buffer scopes - -In this implementation, aliasing barriers are automatically inserted when: -- A pass accesses a resource that shares a physical allocation -- A different resource was previously active on that allocation -- The active resource hasn't been explicitly destroyed - -## Example Output - -``` -[RG] ===== RESOURCE ALIASING ANALYSIS ===== -[ALLOC] 'GBuffer.Albedo' gets new allocation 'Physical_Texture_2' (size: 8.29 MB, lifetime: [0..1]) -[ALIAS] 'SSAO' aliases with 'Physical_Texture_2' (offset: 0, size: 8.29 MB, lifetime: [2..4]) -[ALIAS] 'BloomDownsample' aliases with 'Physical_Texture_1' (offset: 0, size: 8.29 MB, lifetime: [3..5]) - -[RG] Memory Statistics: - Total memory without aliasing: 80.64 MB - Total memory with aliasing: 47.46 MB - Memory saved: 33.18 MB (41.1%) - Allocations: 5 physical allocations for 8 resources -``` - -## Aliasing Algorithm - -The allocator uses a **First-Fit** strategy: - -```csharp -foreach (var resource in transientResources.OrderBy(FirstUse).ThenBy(Size)) -{ - // Try to find existing allocation - foreach (var slot in allocationSlots) - { - if (slot.LargeEnough && - slot.SameType && - !HasLifetimeOverlap(slot, resource)) - { - // REUSE! - slot.AddResource(resource); - return; - } - } - - // No compatible slot found, create new allocation - CreateNewAllocation(resource); -} -``` - -### Key Constraints - -1. **Size**: The physical allocation must be >= required size -2. **Type**: Textures can only alias with textures, buffers with buffers -3. **Lifetime**: Resources must have non-overlapping lifetimes -4. **Alignment**: Resources must satisfy GPU alignment requirements - -## Real-World Benefits - -### Deferred Rendering Pipeline - -| Resource | Size | Lifetime | Physical Alloc | -|----------|------|----------|----------------| -| GBuffer.Albedo | 8MB | [0..1] | Physical_1 | -| GBuffer.Normal | 16MB | [0..2] | Physical_2 | -| GBuffer.Depth | 8MB | [0..2] | Physical_3 | -| Lighting | 16MB | [1..3] | Physical_4 | -| SSAO | 8MB | [2..4] | **Physical_1** ✓ | -| TAA | 16MB | [3..4] | **Physical_2** ✓ | -| Bloom | 8MB | [3..5] | **Physical_3** ✓ | - -**Without aliasing**: 80MB -**With aliasing**: 48MB -**Savings**: 40% (32MB) - -### At 4K Resolution (3840x2160) - -| Format | Size (1080p) | Size (4K) | -|--------|-------------|-----------| -| RGBA8 | 8.3 MB | 33.2 MB | -| RGBA16F | 16.6 MB | 66.4 MB | -| Depth32F | 8.3 MB | 33.2 MB | - -**4K Savings**: 128MB → Modern AAA games save **hundreds of megabytes** to **gigabytes** using this technique. - -## Advanced Optimizations (Not Implemented) - -### 1. Pool-Based Allocation -Instead of individual allocations, use large memory pools and sub-allocate from them. - -### 2. Heap-Aware Aliasing -D3D12 has specific heap types (Default, Upload, Readback). Resources can only alias within the same heap type. - -### 3. Subresource Aliasing -Alias mip levels or array slices independently for more granular reuse. - -### 4. Multi-Queue Aliasing -Resources on different queues (Graphics, Compute, Copy) need special synchronization. - -## Comparison with Production Systems - -### Unreal Engine 5 RDG -```cpp -// Automatic aliasing based on lifetimes -FRDGTextureRef TextureA = GraphBuilder.CreateTexture(Desc, TEXT("A")); -FRDGTextureRef TextureB = GraphBuilder.CreateTexture(Desc, TEXT("B")); -// RDG automatically aliases if lifetimes don't overlap -``` - -### Frostbite Frame Graph -- Uses explicit aliasing groups -- Developers can hint which resources should share memory -- More control but less automatic - -### Unity HDRP Render Graph -```csharp -// Unity's approach (similar to ours) -var tempRT = renderGraph.CreateTexture(desc); -// Automatic aliasing through lifetime analysis -``` - -## Performance Impact - -**Memory**: 30-50% reduction typical -**CPU Overhead**: <1ms during compile phase -**GPU Performance**: Same or better (fewer allocations) -**Bandwidth**: Reduced due to better cache locality - -## Debugging Tips - -1. **Print Allocation Map**: See which resources share memory -2. **Visualize Lifetimes**: Graph timeline to spot aliasing opportunities -3. **Track Peak Memory**: Identify frames with poor aliasing -4. **Monitor Aliasing Barriers**: Too many can hurt performance - -## Conclusion - -Resource aliasing is a critical optimization in modern rendering. This proof of concept demonstrates: -- ✅ Automatic lifetime analysis -- ✅ First-fit allocation strategy -- ✅ Type-safe aliasing (textures vs buffers) -- ✅ Memory savings tracking -- ✅ Aliasing barrier insertion points (simulated) - -For production use, integrate with actual D3D12/Vulkan memory heaps and implement proper aliasing barriers as defined by the API specifications. diff --git a/Ghost.RenderGraph.Concept/API_DESIGN.md b/Ghost.RenderGraph.Concept/API_DESIGN.md deleted file mode 100644 index 5f7c3cc..0000000 --- a/Ghost.RenderGraph.Concept/API_DESIGN.md +++ /dev/null @@ -1,189 +0,0 @@ -# Render Graph API Design Summary - -## Overview - -This render graph implementation uses a **production-grade API design** inspired by Unity HDRP's render graph, focusing on performance and usability. - -## Core Design Principles - -### 1. **Typed Pass Data > String Lookups** - -❌ **Anti-pattern** (slow, error-prone): -```csharp -builder.SetRenderFunc(cmd => { - cmd.SetRenderTarget("GBuffer.Albedo"); // String lookup! -}); -``` - -✅ **Best practice** (fast, type-safe): -```csharp -builder.SetRenderFunc((data, cmd) => { - cmd.SetRenderTarget(data.Albedo.Name); // Direct field access! -}); -``` - -### 2. **Blackboard for Complex Data** - -When multiple passes need the same resources (like GBuffer with albedo, normal, depth): - -```csharp -class GBufferData { - public RenderGraphTextureHandle Albedo = null!; - public RenderGraphTextureHandle Normal = null!; - public RenderGraphTextureHandle Depth = null!; -} - -// Producer pass -using (var builder = renderGraph.AddRenderPass("GBuffer", out var data)) { - data.Albedo = builder.WriteTexture(builder.CreateTexture(...)); - data.Normal = builder.WriteTexture(builder.CreateTexture(...)); - data.Depth = builder.UseDepthBuffer(builder.CreateTexture(...), true); - builder.SetRenderFunc((d, cmd) => { /* use d.Albedo, d.Normal, d.Depth */ }); -} -renderGraph.Blackboard.Add(gbufferData); - -// Consumer passes -using (var builder = renderGraph.AddRenderPass("Lighting", out var data)) { - var gbuffer = renderGraph.Blackboard.Get(); - data.Albedo = builder.ReadTexture(gbuffer.Albedo); - data.Normal = builder.ReadTexture(gbuffer.Normal); - // ... -} -``` - -### 3. **Direct Handle Passing for Simple Cases** - -When passing a single texture between two passes: - -```csharp -// Pass 1: Return handle -RenderGraphTextureHandle lightingOutput; -using (var builder = renderGraph.AddRenderPass("Lighting", out var data)) { - lightingOutput = builder.CreateTexture(...); - data.Output = builder.WriteTexture(lightingOutput); - builder.SetRenderFunc((d, cmd) => { /* ... */ }); -} - -// Pass 2: Use handle directly -using (var builder = renderGraph.AddRenderPass("TAA", out var data)) { - data.Input = builder.ReadTexture(lightingOutput); // Direct pass! - builder.SetRenderFunc((d, cmd) => { /* ... */ }); -} -``` - -## Performance Benefits - -| Aspect | Traditional String-Based | Typed Pass Data | -|--------|-------------------------|-----------------| -| **Resource Access** | Dictionary lookup | Direct field access | -| **Type Safety** | Runtime errors | Compile-time checks | -| **Refactoring** | Find & Replace | Compiler-assisted | -| **IDE Support** | Limited | Full IntelliSense | -| **Performance** | Hash lookup overhead | Zero overhead | - -## Real-World Example - -Here's how a complete deferred rendering pipeline looks: - -```csharp -// 1. GBuffer Pass - produce multiple outputs -GBufferData gbufferData; -using (var builder = renderGraph.AddRenderPass("GBuffer", out gbufferData)) { - gbufferData.Albedo = builder.WriteTexture(builder.CreateTexture(...)); - gbufferData.Normal = builder.WriteTexture(builder.CreateTexture(...)); - gbufferData.Depth = builder.UseDepthBuffer(builder.CreateTexture(...), true); - builder.SetRenderFunc((data, cmd) => { /* render geometry */ }); -} -renderGraph.Blackboard.Add(gbufferData); - -// 2. Lighting Pass - consume GBuffer, produce lighting -RenderGraphTextureHandle lightingOutput; -using (var builder = renderGraph.AddRenderPass("Lighting", out var data)) { - var gbuffer = renderGraph.Blackboard.Get(); - data.GBufferAlbedo = builder.ReadTexture(gbuffer.Albedo); - data.GBufferNormal = builder.ReadTexture(gbuffer.Normal); - data.GBufferDepth = builder.ReadTexture(gbuffer.Depth); - - lightingOutput = builder.CreateTexture(...); - data.Output = builder.WriteTexture(lightingOutput); - builder.SetRenderFunc((data, cmd) => { /* deferred lighting */ }); -} - -// 3. SSAO Pass - also consume GBuffer -RenderGraphTextureHandle ssaoOutput; -using (var builder = renderGraph.AddRenderPass("SSAO", out var data)) { - var gbuffer = renderGraph.Blackboard.Get(); - data.Depth = builder.ReadTexture(gbuffer.Depth); - data.Normal = builder.ReadTexture(gbuffer.Normal); - - ssaoOutput = builder.CreateTexture(...); - data.Output = builder.WriteTexture(ssaoOutput); - builder.SetRenderFunc((data, cmd) => { /* SSAO */ }); -} - -// 4. Post Processing - combine lighting + SSAO -using (var builder = renderGraph.AddRenderPass("Post", out var data)) { - data.Lighting = builder.ReadTexture(lightingOutput); // Direct handle - data.SSAO = builder.ReadTexture(ssaoOutput); // Direct handle - data.Output = builder.WriteTexture(backbuffer); - builder.SetRenderFunc((data, cmd) => { /* combine */ }); -} - -renderGraph.Compile(); -renderGraph.Execute(); -``` - -## When to Use What? - -| Scenario | Use | Example | -|----------|-----|---------| -| Multiple outputs used by many passes | **Blackboard** | GBuffer (albedo, normal, depth) | -| Single texture passed to next pass | **Direct Handle** | Lighting → TAA | -| Temporary working data | **Pass Data** | Intermediate blur textures | -| Persistent frame data | **Import** | Backbuffer, history textures | - -## Comparison with Other Systems - -### Unity HDRP -```csharp -// Unity's API (very similar!) -using (var builder = renderGraph.AddRenderPass("MyPass", out var passData)) -{ - passData.input = builder.ReadTexture(inputHandle); - passData.output = builder.WriteTexture(outputHandle); - builder.SetRenderFunc((data, ctx) => { /* ... */ }); -} -``` - -### Unreal Engine 5 RDG -```cpp -// Unreal's API (similar concepts, different syntax) -FRDGTextureRef Output = GraphBuilder.CreateTexture(Desc, TEXT("Output")); -AddPass(GraphBuilder, "MyPass", Parameters, - [Parameters](FRHICommandList& RHICmdList) { - // Execute - }); -``` - -### Frostbite -```cpp -// Frostbite (original frame graph paper) -FrameGraphTextureHandle output = frameGraph.create("Output", desc); -frameGraph.addPass("MyPass", - [&](FrameGraphBuilder& builder) { - builder.write(output); - }, - [=](const Resources& resources, CommandBuffer& cmd) { - // Execute - }); -``` - -## Conclusion - -This API design prioritizes: -1. **Performance**: Zero-cost abstractions with direct field access -2. **Safety**: Compile-time type checking -3. **Ergonomics**: Natural C# patterns (using blocks, typed data) -4. **Flexibility**: Blackboard for complex data, handles for simple cases - -It matches industry-standard patterns from Unity, Unreal, and Frostbite while leveraging C#'s type system for maximum safety and performance. diff --git a/Ghost.RenderGraph.Concept/ConsoleAPI.cs b/Ghost.RenderGraph.Concept/ConsoleAPI.cs new file mode 100644 index 0000000..74ec863 --- /dev/null +++ b/Ghost.RenderGraph.Concept/ConsoleAPI.cs @@ -0,0 +1,16 @@ +namespace Ghost.RenderGraph.Concept; + +internal static class ConsoleAPI +{ + [System.Diagnostics.Conditional("DEBUG")] + public static void WriteLine() + { + Console.WriteLine(); + } + + [System.Diagnostics.Conditional("DEBUG")] + public static void WriteLine(string? message) + { + Console.WriteLine(message); + } +} diff --git a/Ghost.RenderGraph.Concept/Ghost.RenderGraph.Concept.csproj b/Ghost.RenderGraph.Concept/Ghost.RenderGraph.Concept.csproj index ed9781c..e1e1342 100644 --- a/Ghost.RenderGraph.Concept/Ghost.RenderGraph.Concept.csproj +++ b/Ghost.RenderGraph.Concept/Ghost.RenderGraph.Concept.csproj @@ -7,4 +7,12 @@ enable + + + + + + + + diff --git a/Ghost.RenderGraph.Concept/ICommandBuffer.cs b/Ghost.RenderGraph.Concept/ICommandBuffer.cs index 827cf4f..d3205d8 100644 --- a/Ghost.RenderGraph.Concept/ICommandBuffer.cs +++ b/Ghost.RenderGraph.Concept/ICommandBuffer.cs @@ -1,9 +1,39 @@ namespace Ghost.RenderGraph.Concept; +public struct ResourceBarrierInfo +{ + public string ResourceName; + public ResourceState BeforeState; + public ResourceState AfterState; + + public ResourceBarrierInfo(string resourceName, ResourceState beforeState, ResourceState afterState) + { + ResourceName = resourceName; + BeforeState = beforeState; + AfterState = afterState; + } +} + +public struct AliasingBarrierInfo +{ + public string BeforeResourceName; + public string AfterResourceName; + public string PhysicalAllocationName; + + public AliasingBarrierInfo(string beforeResourceName, string afterResourceName, string physicalAllocationName) + { + BeforeResourceName = beforeResourceName; + AfterResourceName = afterResourceName; + PhysicalAllocationName = physicalAllocationName; + } +} + public interface ICommandBuffer { void ResourceBarrier(string resourceName, ResourceState beforeState, ResourceState afterState); + void ResourceBarrier(Span barriers); void AliasingBarrier(string beforeResourceName, string afterResourceName, string physicalAllocationName); + void AliasingBarrier(Span barriers); void BeginRenderPass(string passName); void EndRenderPass(); void SetRenderTarget(string textureName); @@ -21,66 +51,118 @@ public class SimulatedCommandBuffer : ICommandBuffer { public void ResourceBarrier(string resourceName, ResourceState beforeState, ResourceState afterState) { - Console.WriteLine($" [BARRIER] Transition '{resourceName}' from {beforeState} to {afterState}"); + //ConsoleAPI.WriteLine($" [BARRIER] Transition '{resourceName}' from {beforeState} to {afterState}"); + } + + public void ResourceBarrier(Span barriers) + { + if (barriers.Length == 0) return; + //ConsoleAPI.WriteLine($" [BARRIER_BATCH] Processing {barriers.Length} transitions:"); + foreach (var barrier in barriers) + { + //ConsoleAPI.WriteLine($" - Transition '{barrier.ResourceName}' from {barrier.BeforeState} to {barrier.AfterState}"); + } } public void AliasingBarrier(string beforeResourceName, string afterResourceName, string physicalAllocationName) { - Console.WriteLine($" [ALIAS_BARRIER] Alias '{physicalAllocationName}': '{beforeResourceName}' -> '{afterResourceName}'"); + //ConsoleAPI.WriteLine($" [ALIAS_BARRIER] Alias '{physicalAllocationName}': '{beforeResourceName}' -> '{afterResourceName}'"); } + public void AliasingBarrier(Span barriers) + { + if (barriers.Length == 0) return; + //ConsoleAPI.WriteLine($" [ALIAS_BARRIER_BATCH] Processing {barriers.Length} aliasing barriers:"); + foreach (var barrier in barriers) + { + //ConsoleAPI.WriteLine($" - Alias '{barrier.PhysicalAllocationName}': '{barrier.BeforeResourceName}' -> '{barrier.AfterResourceName}'"); + } + } + + public void BeginRenderPass(string passName) { - Console.WriteLine($" [BEGIN] RenderPass '{passName}'"); + //ConsoleAPI.WriteLine($" [BEGIN] RenderPass '{passName}'"); } public void EndRenderPass() { - Console.WriteLine($" [END] RenderPass"); + //ConsoleAPI.WriteLine($" [END] RenderPass"); } public void SetRenderTarget(string textureName) { - Console.WriteLine($" [RT] Set RenderTarget: '{textureName}'"); + //ConsoleAPI.WriteLine($" [RT] Set RenderTarget: '{textureName}'"); } public void SetDepthStencil(string textureName) { - Console.WriteLine($" [DS] Set DepthStencil: '{textureName}'"); + //ConsoleAPI.WriteLine($" [DS] Set DepthStencil: '{textureName}'"); } public void BindShaderResource(string resourceName, int slot) { - Console.WriteLine($" [SRV] Bind ShaderResource: '{resourceName}' at slot {slot}"); + //ConsoleAPI.WriteLine($" [SRV] Bind ShaderResource: '{resourceName}' at slot {slot}"); } public void BindUnorderedAccess(string resourceName, int slot) { - Console.WriteLine($" [UAV] Bind UnorderedAccess: '{resourceName}' at slot {slot}"); + //ConsoleAPI.WriteLine($" [UAV] Bind UnorderedAccess: '{resourceName}' at slot {slot}"); } public void Draw(int vertexCount) { - Console.WriteLine($" [DRAW] Drawing {vertexCount} vertices"); + //ConsoleAPI.WriteLine($" [DRAW] Drawing {vertexCount} vertices"); } public void Dispatch(int x, int y, int z) { - Console.WriteLine($" [DISPATCH] Compute ({x}, {y}, {z})"); + //ConsoleAPI.WriteLine($" [DISPATCH] Compute ({x}, {y}, {z})"); } public void ClearRenderTarget(string textureName, float r, float g, float b, float a) { - Console.WriteLine($" [CLEAR_RT] Clear '{textureName}' to ({r}, {g}, {b}, {a})"); + //ConsoleAPI.WriteLine($" [CLEAR_RT] Clear '{textureName}' to ({r}, {g}, {b}, {a})"); } public void ClearDepth(string textureName, float depth) { - Console.WriteLine($" [CLEAR_DEPTH] Clear '{textureName}' to {depth}"); + //ConsoleAPI.WriteLine($" [CLEAR_DEPTH] Clear '{textureName}' to {depth}"); } public void CopyTexture(string source, string destination) { - Console.WriteLine($" [COPY] Copy from '{source}' to '{destination}'"); + //ConsoleAPI.WriteLine($" [COPY] Copy from '{source}' to '{destination}'"); } } + +public readonly struct RasterRenderContext +{ + private readonly ICommandBuffer _cmd; + + public RasterRenderContext(ICommandBuffer cmd) + { + _cmd = cmd; + } + + public void SetRenderTarget(string textureName) => _cmd.SetRenderTarget(textureName); + public void SetDepthStencil(string textureName) => _cmd.SetDepthStencil(textureName); + public void BindShaderResource(string resourceName, int slot) => _cmd.BindShaderResource(resourceName, slot); + public void Draw(int vertexCount) => _cmd.Draw(vertexCount); + public void ClearRenderTarget(string textureName, float r, float g, float b, float a) => _cmd.ClearRenderTarget(textureName, r, g, b, a); + public void ClearDepth(string textureName, float depth) => _cmd.ClearDepth(textureName, depth); +} + +public readonly struct ComputeRenderContext +{ + private readonly ICommandBuffer _cmd; + + public ComputeRenderContext(ICommandBuffer cmd) + { + _cmd = cmd; + } + + public void BindShaderResource(string resourceName, int slot) => _cmd.BindShaderResource(resourceName, slot); + public void BindUnorderedAccess(string resourceName, int slot) => _cmd.BindUnorderedAccess(resourceName, slot); + public void Dispatch(int x, int y, int z) => _cmd.Dispatch(x, y, z); +} diff --git a/Ghost.RenderGraph.Concept/PassData.cs b/Ghost.RenderGraph.Concept/PassData.cs index a080ade..c7ddfb3 100644 --- a/Ghost.RenderGraph.Concept/PassData.cs +++ b/Ghost.RenderGraph.Concept/PassData.cs @@ -3,56 +3,56 @@ namespace Ghost.RenderGraph.Concept; // Pass data structure for GBuffer outputs public class GBufferData { - public RenderGraphTextureHandle Albedo = null!; - public RenderGraphTextureHandle Normal = null!; - public RenderGraphTextureHandle Depth = null!; + public RenderGraphTextureHandle Albedo; + public RenderGraphTextureHandle Normal; + public RenderGraphTextureHandle Depth; } public class LightingPassData { - public RenderGraphTextureHandle GBufferAlbedo = null!; - public RenderGraphTextureHandle GBufferNormal = null!; - public RenderGraphTextureHandle GBufferDepth = null!; - public RenderGraphTextureHandle OutputLighting = null!; + public RenderGraphTextureHandle GBufferAlbedo; + public RenderGraphTextureHandle GBufferNormal; + public RenderGraphTextureHandle GBufferDepth; + public RenderGraphTextureHandle OutputLighting; } public class SSAOPassData { - public RenderGraphTextureHandle GBufferDepth = null!; - public RenderGraphTextureHandle GBufferNormal = null!; - public RenderGraphTextureHandle OutputSSAO = null!; + public RenderGraphTextureHandle GBufferDepth; + public RenderGraphTextureHandle GBufferNormal; + public RenderGraphTextureHandle OutputSSAO; } public class TAAPassData { - public RenderGraphTextureHandle InputLighting = null!; - public RenderGraphTextureHandle OutputTAA = null!; + public RenderGraphTextureHandle InputLighting; + public RenderGraphTextureHandle OutputTAA; } public class PostProcessingPassData { - public RenderGraphTextureHandle InputTAA = null!; - public RenderGraphTextureHandle InputSSAO = null!; - public RenderGraphTextureHandle OutputBackbuffer = null!; + public RenderGraphTextureHandle InputTAA; + public RenderGraphTextureHandle InputSSAO; + public RenderGraphTextureHandle OutputBackbuffer; } public class DebugPassData { - public RenderGraphTextureHandle DebugTexture = null!; + public RenderGraphTextureHandle DebugTexture; } public class ProfilerMarkerData { } public class BloomDownsampleData { - public RenderGraphTextureHandle Input = null!; - public RenderGraphTextureHandle Output = null!; + public RenderGraphTextureHandle Input; + public RenderGraphTextureHandle Output; } public class PostProcessingPassDataV2 { - public RenderGraphTextureHandle InputTAA = null!; - public RenderGraphTextureHandle InputSSAO = null!; - public RenderGraphTextureHandle InputBloom = null!; - public RenderGraphTextureHandle OutputBackbuffer = null!; + public RenderGraphTextureHandle InputTAA; + public RenderGraphTextureHandle InputSSAO; + public RenderGraphTextureHandle InputBloom; + public RenderGraphTextureHandle OutputBackbuffer; } diff --git a/Ghost.RenderGraph.Concept/Program.cs b/Ghost.RenderGraph.Concept/Program.cs index c489399..708c5f3 100644 --- a/Ghost.RenderGraph.Concept/Program.cs +++ b/Ghost.RenderGraph.Concept/Program.cs @@ -1,177 +1,208 @@ using Ghost.RenderGraph.Concept; -Console.WriteLine("=================================================="); -Console.WriteLine(" Transient Render Graph - Proof of Concept"); -Console.WriteLine(" Using Typed Pass Data and Blackboard Pattern"); -Console.WriteLine("==================================================\n"); + +//ConsoleAPI.WriteLine("=================================================="); +//ConsoleAPI.WriteLine(" Transient Render Graph - Proof of Concept"); +//ConsoleAPI.WriteLine(" Using Typed Pass Data and Blackboard Pattern"); +//ConsoleAPI.WriteLine("==================================================\n"); var renderGraph = new RenderGraph(); -// Import external resources -var backbuffer = renderGraph.ImportTexture( - "Backbuffer", - new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "Backbuffer")); - -// ===== GBuffer Pass ===== -GBufferData gbufferData; -using (var builder = renderGraph.AddRenderPass("GBuffer Pass", out gbufferData)) +for (int i = 0; i < 500; i++) { - // Create GBuffer textures - var albedo = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "GBuffer.Albedo")); - var normal = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "GBuffer.Normal")); - var depth = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.Depth32F, "GBuffer.Depth")); - - // Store in pass data and mark as written - gbufferData.Albedo = builder.WriteTexture(albedo); - gbufferData.Normal = builder.WriteTexture(normal); - gbufferData.Depth = builder.UseDepthBuffer(depth, writeAccess: true); - - builder.SetRenderFunc((data, cmd) => - { - cmd.SetRenderTarget(data.Albedo.Name); - cmd.SetRenderTarget(data.Normal.Name); - cmd.SetDepthStencil(data.Depth.Name); - cmd.ClearRenderTarget(data.Albedo.Name, 0, 0, 0, 1); - cmd.ClearRenderTarget(data.Normal.Name, 0.5f, 0.5f, 1.0f, 1); - cmd.ClearDepth(data.Depth.Name, 1.0f); - cmd.Draw(36000); - }); + BuildGraph(renderGraph); } -// Store GBuffer data in blackboard for other passes -renderGraph.Blackboard.Add(gbufferData); +var sw = new System.Diagnostics.Stopwatch(); +var gcBefore = GC.GetAllocatedBytesForCurrentThread(); +sw.Start(); -// ===== Lighting Pass ===== -RenderGraphTextureHandle lightingOutput; -using (var builder = renderGraph.AddRenderPass("Lighting Pass", out var lightingData)) +for (int i = 0; i < 500; i++) { - // Read GBuffer from blackboard - var gbuffer = renderGraph.Blackboard.Get(); - - lightingData.GBufferAlbedo = builder.ReadTexture(gbuffer.Albedo); - lightingData.GBufferNormal = builder.ReadTexture(gbuffer.Normal); - lightingData.GBufferDepth = builder.ReadTexture(gbuffer.Depth); - - // Create output texture - lightingOutput = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "LightingResult")); - lightingData.OutputLighting = builder.WriteTexture(lightingOutput); - - builder.SetRenderFunc((data, cmd) => - { - cmd.BindShaderResource(data.GBufferAlbedo.Name, 0); - cmd.BindShaderResource(data.GBufferNormal.Name, 1); - cmd.BindShaderResource(data.GBufferDepth.Name, 2); - cmd.SetRenderTarget(data.OutputLighting.Name); - cmd.Draw(3); - }); + BuildGraph(renderGraph); } -// ===== SSAO Pass ===== -RenderGraphTextureHandle ssaoOutput; -using (var builder = renderGraph.AddRenderPass("SSAO Pass", out var ssaoData)) +//BuildGraph(renderGraph); + +sw.Stop(); +var gcAfter = GC.GetAllocatedBytesForCurrentThread(); + +Console.WriteLine($"{sw.Elapsed.TotalNanoseconds / 500} ns"); +Console.WriteLine($"GC Allocated Bytes: {(gcAfter - gcBefore) / 500} bytes"); + +//Console.WriteLine("\nPress any key to exit..."); +//Console.ReadKey(); + +static void BuildGraph(RenderGraph renderGraph) { - var gbuffer = renderGraph.Blackboard.Get(); - - ssaoData.GBufferDepth = builder.ReadTexture(gbuffer.Depth); - ssaoData.GBufferNormal = builder.ReadTexture(gbuffer.Normal); + renderGraph.Reset(); - // This will reuse GBuffer.Albedo's memory allocation - ssaoOutput = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "SSAO")); - ssaoData.OutputSSAO = builder.WriteTexture(ssaoOutput); + // Import external resources + var backbuffer = renderGraph.ImportTexture( + "Backbuffer", + new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "Backbuffer")); - builder.SetRenderFunc((data, cmd) => + // ===== GBuffer Pass ===== + GBufferData gbufferData; + using (var builder = renderGraph.AddRenderPass("GBuffer Pass", out gbufferData)) { - cmd.BindShaderResource(data.GBufferDepth.Name, 0); - cmd.BindShaderResource(data.GBufferNormal.Name, 1); - cmd.SetRenderTarget(data.OutputSSAO.Name); - cmd.Draw(3); - }); -} + // Create GBuffer textures + var albedo = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "GBuffer.Albedo")); + var normal = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "GBuffer.Normal")); + var depth = builder.CreateTexture(new TextureDescriptor(1920, 1080, TextureFormat.Depth32F, "GBuffer.Depth")); -// ===== Bloom Downsample Pass (will alias with albedo) ===== -RenderGraphTextureHandle bloomOutput; -using (var builder = renderGraph.AddRenderPass("Bloom Downsample", out var bloomData)) -{ - bloomData.Input = builder.ReadTexture(lightingOutput); - - // Create a texture that will alias with SSAO (same size, same format) - bloomOutput = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "BloomDownsample")); - bloomData.Output = builder.WriteTexture(bloomOutput); + // Store in pass data and mark as written + gbufferData.Albedo = builder.WriteTexture(albedo); + gbufferData.Normal = builder.WriteTexture(normal); + gbufferData.Depth = builder.UseDepthBuffer(depth, writeAccess: true); - builder.SetRenderFunc((data, cmd) => + builder.SetRenderFunc((data, cmd) => + { + cmd.SetRenderTarget(data.Albedo.Name); + cmd.SetRenderTarget(data.Normal.Name); + cmd.SetDepthStencil(data.Depth.Name); + cmd.ClearRenderTarget(data.Albedo.Name, 0, 0, 0, 1); + cmd.ClearRenderTarget(data.Normal.Name, 0.5f, 0.5f, 1.0f, 1); + cmd.ClearDepth(data.Depth.Name, 1.0f); + cmd.Draw(36000); + }); + } + + // Store GBuffer data in blackboard for other passes + renderGraph.Blackboard.Add(gbufferData); + + // ===== Lighting Pass ===== + RenderGraphTextureHandle lightingOutput; + using (var builder = renderGraph.AddRenderPass("Lighting Pass", out var lightingData)) { - cmd.BindShaderResource(data.Input.Name, 0); - cmd.SetRenderTarget(data.Output.Name); - cmd.Draw(3); - }); -} + // Read GBuffer from blackboard + var gbuffer = renderGraph.Blackboard.Get(); -// ===== Temporal AA Pass ===== -RenderGraphTextureHandle taaOutput; -using (var builder = renderGraph.AddRenderPass("Temporal AA", out var taaData)) -{ - taaData.InputLighting = builder.ReadTexture(lightingOutput); + lightingData.GBufferAlbedo = builder.ReadTexture(gbuffer.Albedo); + lightingData.GBufferNormal = builder.ReadTexture(gbuffer.Normal); + lightingData.GBufferDepth = builder.ReadTexture(gbuffer.Depth); - taaOutput = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "TAA.Result")); - taaData.OutputTAA = builder.WriteTexture(taaOutput); + // Create output texture + lightingOutput = builder.CreateTexture( + new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "LightingResult")); + lightingData.OutputLighting = builder.WriteTexture(lightingOutput); - builder.SetRenderFunc((data, cmd) => + builder.SetRenderFunc((data, cmd) => + { + cmd.BindShaderResource(data.GBufferAlbedo.Name, 0); + cmd.BindShaderResource(data.GBufferNormal.Name, 1); + cmd.BindShaderResource(data.GBufferDepth.Name, 2); + cmd.SetRenderTarget(data.OutputLighting.Name); + cmd.Draw(3); + }); + } + + // ===== SSAO Pass (Async Compute) ===== + RenderGraphTextureHandle ssaoOutput; + using (var builder = renderGraph.AddRenderPass("SSAO Pass (Async)", out var ssaoData)) { - cmd.BindShaderResource(data.InputLighting.Name, 0); - cmd.SetRenderTarget(data.OutputTAA.Name); - cmd.Draw(3); - }); -} + var gbuffer = renderGraph.Blackboard.Get(); -// ===== Post Processing Pass ===== -using (var builder = renderGraph.AddRenderPass("Post Processing", out var postData)) -{ - postData.InputTAA = builder.ReadTexture(taaOutput); - postData.InputSSAO = builder.ReadTexture(ssaoOutput); - postData.InputBloom = builder.ReadTexture(bloomOutput); - postData.OutputBackbuffer = builder.WriteTexture(backbuffer); + ssaoData.GBufferDepth = builder.ReadTexture(gbuffer.Depth); + ssaoData.GBufferNormal = builder.ReadTexture(gbuffer.Normal); - builder.SetRenderFunc((data, cmd) => + // SSAO Output + ssaoOutput = builder.CreateTexture( + new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "SSAO")); + ssaoData.OutputSSAO = builder.WriteTexture(ssaoOutput); + + // Use SetComputeFunc with asyncCompute: true + builder.SetComputeFunc((data, cmd) => + { + cmd.BindShaderResource(data.GBufferDepth.Name, 0); + cmd.BindShaderResource(data.GBufferNormal.Name, 1); + cmd.BindUnorderedAccess(data.OutputSSAO.Name, 0); + cmd.Dispatch(1920 / 8, 1080 / 8, 1); + }, asyncCompute: true); + } + + // ===== Bloom Downsample Pass (will alias with albedo) ===== + RenderGraphTextureHandle bloomOutput; + using (var builder = renderGraph.AddRenderPass("Bloom Downsample", out var bloomData)) { - cmd.BindShaderResource(data.InputTAA.Name, 0); - cmd.BindShaderResource(data.InputSSAO.Name, 1); - cmd.BindShaderResource(data.InputBloom.Name, 2); - cmd.SetRenderTarget(data.OutputBackbuffer.Name); - cmd.Draw(3); - }); -} + bloomData.Input = builder.ReadTexture(lightingOutput); -// ===== GPU Profiler Marker Pass (non-cullable, textureless) ===== -using (var builder = renderGraph.AddRenderPass("GPU Profiler Begin Frame", out var profilerData)) -{ - builder.SetAllowCulling(false); // Never cull this - it's for debugging/profiling - builder.SetRenderFunc((data, cmd) => + // Create a texture that will alias with SSAO (same size, same format) + bloomOutput = builder.CreateTexture( + new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "BloomDownsample")); + bloomData.Output = builder.WriteTexture(bloomOutput); + + builder.SetRenderFunc((data, cmd) => + { + cmd.BindShaderResource(data.Input.Name, 0); + cmd.SetRenderTarget(data.Output.Name); + cmd.Draw(3); + }); + } + + // ===== Temporal AA Pass ===== + RenderGraphTextureHandle taaOutput; + using (var builder = renderGraph.AddRenderPass("Temporal AA", out var taaData)) { - Console.WriteLine(" [PROFILER] BeginEvent('Frame')"); - }); -} + taaData.InputLighting = builder.ReadTexture(lightingOutput); -// ===== Unused Debug Pass (will be culled) ===== -using (var builder = renderGraph.AddRenderPass("Unused Debug Pass", out var debugData)) -{ - debugData.DebugTexture = builder.WriteTexture( - builder.CreateTexture(new TextureDescriptor(512, 512, TextureFormat.RGBA8, "DebugTexture"))); + taaOutput = builder.CreateTexture( + new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "TAA.Result")); + taaData.OutputTAA = builder.WriteTexture(taaOutput); - builder.SetRenderFunc((data, cmd) => + builder.SetRenderFunc((data, cmd) => + { + cmd.BindShaderResource(data.InputLighting.Name, 0); + cmd.SetRenderTarget(data.OutputTAA.Name); + cmd.Draw(3); + }); + } + + // ===== Post Processing Pass ===== + using (var builder = renderGraph.AddRenderPass("Post Processing", out var postData)) { - cmd.SetRenderTarget(data.DebugTexture.Name); - cmd.ClearRenderTarget(data.DebugTexture.Name, 1, 0, 1, 1); - cmd.Draw(100); - }); -} + postData.InputTAA = builder.ReadTexture(taaOutput); + postData.InputSSAO = builder.ReadTexture(ssaoOutput); + postData.InputBloom = builder.ReadTexture(bloomOutput); + postData.OutputBackbuffer = builder.WriteTexture(backbuffer); -// Compile and execute the render graph -renderGraph.Compile(); -renderGraph.Execute(); + builder.SetRenderFunc((data, cmd) => + { + cmd.BindShaderResource(data.InputTAA.Name, 0); + cmd.BindShaderResource(data.InputSSAO.Name, 1); + cmd.BindShaderResource(data.InputBloom.Name, 2); + cmd.SetRenderTarget(data.OutputBackbuffer.Name); + cmd.Draw(3); + }); + } -Console.WriteLine("\nPress any key to exit..."); -Console.ReadKey(); + // ===== GPU Profiler Marker Pass (non-cullable, textureless) ===== + using (var builder = renderGraph.AddRenderPass("GPU Profiler Begin Frame", out var profilerData)) + { + builder.SetAllowCulling(false); // Never cull this - it's for debugging/profiling + builder.SetRenderFunc((data, cmd) => + { + // Note: In a real implementation we would have specific profiler commands + // For now, since RasterRenderContext doesn't expose generic console write, we skip the print + // or we would add a specific Profiler method to the context + }); + } + + // ===== Unused Debug Pass (will be culled) ===== + using (var builder = renderGraph.AddRenderPass("Unused Debug Pass", out var debugData)) + { + debugData.DebugTexture = builder.WriteTexture( + builder.CreateTexture(new TextureDescriptor(512, 512, TextureFormat.RGBA8, "DebugTexture"))); + + builder.SetRenderFunc((data, cmd) => + { + cmd.SetRenderTarget(data.DebugTexture.Name); + cmd.ClearRenderTarget(data.DebugTexture.Name, 1, 0, 1, 1); + cmd.Draw(100); + }); + } + + // Compile and execute the render graph + renderGraph.Compile(); + renderGraph.Execute(); +} \ No newline at end of file diff --git a/Ghost.RenderGraph.Concept/README.md b/Ghost.RenderGraph.Concept/README.md deleted file mode 100644 index 01d8b68..0000000 --- a/Ghost.RenderGraph.Concept/README.md +++ /dev/null @@ -1,306 +0,0 @@ -# Transient Render Graph - Proof of Concept - -This is a high-level proof of concept implementation of a modern transient render graph system, inspired by: -- **Unreal Engine 5 RDG** (Render Dependency Graph) -- **Frostbite Frame Graph** -- **Unity HDRP Render Graph** - -## Key Features - -### 1. **Resource Virtualization** -Resources are declared during setup but not physically created until execution. This allows the graph to analyze the entire frame before committing to resource allocation. - -### 2. **Automatic Resource Lifetime Management** -- Resources are created only when first needed (at their `FirstUse` pass) -- Resources are destroyed immediately after their last use (at their `LastUse` pass) -- Imported resources (like backbuffer) are never destroyed by the graph - -### 3. **Automatic Barrier Insertion** -The graph automatically inserts resource state transitions based on how resources are used: -- Write operations: `RenderTarget`, `DepthWrite`, `UnorderedAccess`, `CopyDest` -- Read operations: `ShaderResource`, `DepthRead`, `CopySource` - -### 4. **Automatic Pass Dependencies** -Dependencies are automatically inferred from resource usage patterns: -- **Read-After-Write (RAW)**: Pass B reads what Pass A wrote -- **Write-After-Read (WAR)**: Pass B writes to what Pass A read -- **Write-After-Write (WAW)**: Pass B writes to what Pass A wrote - -### 5. **Pass Culling** -Passes that don't contribute to the final output are automatically culled: -- Starts from imported resources (outputs) -- Recursively marks all dependent passes as needed -- Unused passes are not executed - -## Architecture - -### Core Classes - -#### `RenderGraph` -The main orchestrator that manages the entire frame graph: -- **Setup Phase**: Declare resources and passes -- **Compile Phase**: Build dependencies, cull passes, analyze lifetimes -- **Execute Phase**: Create resources, insert barriers, execute passes, destroy resources - -#### `RenderGraphResourceHandle` -Handle representing a virtual resource: -- `RenderGraphTextureHandle`: Textures with format, size -- `RenderGraphBufferHandle`: Buffers with size - -#### `IRenderGraphBuilder` -Builder interface used during pass setup: -- `ReadTexture()` / `ReadBuffer()`: Declare read access -- `WriteTexture()` / `WriteBuffer()`: Declare write access -- `CreateTransientTexture()` / `CreateTransientBuffer()`: Create temporary resources - -#### `ICommandBuffer` -Abstraction for executing graphics commands (simulated with `Console.WriteLine`) - -### Resource Lifetime Example - -``` -GBuffer.Albedo: [0..1] Created in pass 0, destroyed after pass 1 -GBuffer.Normal: [0..2] Created in pass 0, destroyed after pass 2 -GBuffer.Depth: [0..2] Created in pass 0, destroyed after pass 2 -LightingResult: [1..3] Created in pass 1, destroyed after pass 3 -SSAO: [2..4] Created in pass 2, destroyed after pass 4 -TAA.Result: [3..4] Created in pass 3, destroyed after pass 4 -Backbuffer: [4..4] Imported (never created/destroyed) -``` - -## Usage Example - -### Pattern 1: Using Typed Pass Data with Blackboard (Recommended) - -```csharp -var renderGraph = new RenderGraph(); - -// Import external resources (e.g., backbuffer) -var backbuffer = renderGraph.ImportTexture( - "Backbuffer", - new TextureDescriptor(1920, 1080, TextureFormat.RGBA8)); - -// Define pass data structure -class GBufferData -{ - public RenderGraphTextureHandle Albedo = null!; - public RenderGraphTextureHandle Normal = null!; - public RenderGraphTextureHandle Depth = null!; -} - -// Create GBuffer pass with typed data -GBufferData gbufferData; -using (var builder = renderGraph.AddRenderPass("GBuffer Pass", out gbufferData)) -{ - // Create transient resources - var albedo = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA8, "GBuffer.Albedo")); - var normal = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "GBuffer.Normal")); - var depth = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.Depth32F, "GBuffer.Depth")); - - // Store in pass data and declare access - gbufferData.Albedo = builder.WriteTexture(albedo); - gbufferData.Normal = builder.WriteTexture(normal); - gbufferData.Depth = builder.UseDepthBuffer(depth, writeAccess: true); - - // Set render function with typed data - builder.SetRenderFunc((data, cmd) => - { - cmd.SetRenderTarget(data.Albedo.Name); - cmd.SetRenderTarget(data.Normal.Name); - cmd.SetDepthStencil(data.Depth.Name); - cmd.Draw(36000); - }); -} - -// Store in blackboard for other passes -renderGraph.Blackboard.Add(gbufferData); - -// ===== Lighting Pass ===== -class LightingPassData -{ - public RenderGraphTextureHandle GBufferAlbedo = null!; - public RenderGraphTextureHandle GBufferNormal = null!; - public RenderGraphTextureHandle OutputLighting = null!; -} - -RenderGraphTextureHandle lightingOutput; -using (var builder = renderGraph.AddRenderPass("Lighting Pass", out var lightingData)) -{ - // Read GBuffer from blackboard - var gbuffer = renderGraph.Blackboard.Get(); - - lightingData.GBufferAlbedo = builder.ReadTexture(gbuffer.Albedo); - lightingData.GBufferNormal = builder.ReadTexture(gbuffer.Normal); - - // Create and return output handle - lightingOutput = builder.CreateTexture( - new TextureDescriptor(1920, 1080, TextureFormat.RGBA16F, "Lighting")); - lightingData.OutputLighting = builder.WriteTexture(lightingOutput); - - builder.SetRenderFunc((data, cmd) => - { - cmd.BindShaderResource(data.GBufferAlbedo.Name, 0); - cmd.BindShaderResource(data.GBufferNormal.Name, 1); - cmd.SetRenderTarget(data.OutputLighting.Name); - cmd.Draw(3); - }); -} - -// Compile and execute -renderGraph.Compile(); -renderGraph.Execute(); -``` - -### Pattern 2: Simple Handle Passing - -For simple cases where you just need to pass one or two textures between passes, you can skip the blackboard: - -```csharp -// Create and return a handle -RenderGraphTextureHandle myTexture; -using (var builder = renderGraph.AddRenderPass("Pass 1", out var data)) -{ - myTexture = builder.CreateTexture(new TextureDescriptor(...)); - data.Output = builder.WriteTexture(myTexture); - builder.SetRenderFunc((d, cmd) => { /* ... */ }); -} - -// Use the handle in next pass -using (var builder = renderGraph.AddRenderPass("Pass 2", out var data)) -{ - data.Input = builder.ReadTexture(myTexture); - builder.SetRenderFunc((d, cmd) => { /* ... */ }); -} -``` - -## Key API Design Features - -### 1. **Typed Pass Data** -Each pass has a strongly-typed data structure that holds all its resource handles. This: -- Makes resource dependencies explicit and compile-time safe -- Avoids string-based lookups during execution -- Enables better IDE support and refactoring - -### 2. **Blackboard Pattern** -For sharing data structures between multiple passes: -- Store complex data (like GBuffer with multiple textures) in the blackboard -- Other passes retrieve it type-safely -- Useful for resources used by many passes - -### 3. **Direct Handle Passing** -For simple cases: -- Return a `RenderGraphTextureHandle` from a pass setup -- Pass it directly to the next pass -- No need for blackboard overhead - -### 4. **Using Block Pattern** -The `using` statement automatically commits the pass when the block ends: -- Builder is disposed → pass is committed to the graph -- Ensures all passes are properly registered -- Mimics Unity HDRP's render graph API - -## Benefits of Transient Resources - -1. **Memory Efficiency**: Resources only exist when needed, allowing memory reuse -2. **Automatic Synchronization**: Barriers inserted automatically based on usage -3. **Self-Documenting**: Clear declaration of what each pass reads/writes -4. **Type Safety**: Compile-time checking of pass data structures -5. **Performance**: No string lookups or dictionary access during execution -6. **Optimization Opportunities**: Graph can reorder passes (future work) -7. **Resource Aliasing**: Multiple transient resources can share memory (future work) - -## What's NOT Implemented (Intentionally) - -This is a proof of concept focusing on core graph mechanics. Some features are fully implemented, others are intentionally omitted: - -### ✅ Fully Implemented -- ✅ **Resource aliasing/memory pooling** - Automatic memory reuse for non-overlapping lifetimes -- ✅ **Typed pass data** - Zero-cost abstraction with compile-time safety -- ✅ **Blackboard pattern** - Type-safe data sharing between passes -- ✅ **Automatic barriers** - State transitions inferred from usage - -### ❌ Not Implemented -- ❌ Async compute queues -- ❌ Pass reordering optimization -- ❌ Subresource tracking (mip levels, array slices) -- ❌ Multi-queue synchronization -- ❌ GPU timeline profiling -- ❌ Resource versioning -- ❌ Graph visualization/debugging tools - -## Resource Aliasing (Implemented!) - -Transient resources with non-overlapping lifetimes automatically share the same physical memory: -``` -GBuffer.Albedo [0..1] ━━━━━━━━━━━ - ╰──> Reuse memory (34% savings!) -SSAO [2..4] ━━━━━━━━━━━━━ -``` - -Example output: -``` -[RG] Memory Statistics: - Total memory without aliasing: 72.19 MB - Total memory with aliasing: 47.46 MB - Memory saved: 24.73 MB (34.3%) - Allocations: 4 physical allocations for 7 resources -``` - -See [ALIASING.md](ALIASING.md) for detailed documentation. - -## Future Enhancements - -### Async Compute -Some passes can run on compute queue while graphics queue continues: -``` -Graphics: ━━[GBuffer]━━[Lighting]━━━━━━━━[PostFX]━━ - ║ -Compute: ╚═[SSAO]════╗ - ║ - [Wait]───────╝ -``` - -### Pass Reordering -Independent passes can be reordered for better GPU utilization or to enable more aliasing. - -## Output Example - -The demo program creates a deferred rendering pipeline and produces output like: - -``` -[RG] Building pass dependencies... - Pass 'Lighting Pass' depends on 'GBuffer Pass' - Pass 'SSAO Pass' depends on 'GBuffer Pass' - Pass 'Temporal AA' depends on 'Lighting Pass' - Pass 'Post Processing' depends on 'TAA' and 'SSAO' - -[RG] Culling unused passes... - Culled unused pass: 'Unused Debug Pass' - -[RG] Resource lifetimes: - 'GBuffer.Albedo': [0..1] (GBuffer Pass, Lighting Pass) - 'GBuffer.Normal': [0..2] (GBuffer Pass, Lighting Pass, SSAO Pass) - ... - -[PASS 0] Executing: 'GBuffer Pass' - [CREATE] Texture 'GBuffer.Albedo' (1920x1080, RGBA8) - [BARRIER] Transition 'GBuffer.Albedo' from Undefined to RenderTarget - [BEGIN] RenderPass 'GBuffer Pass' - [RT] Set RenderTarget: 'GBuffer.Albedo' - [DRAW] Drawing 36000 vertices - [END] RenderPass - -[PASS 1] Executing: 'Lighting Pass' - [BARRIER] Transition 'GBuffer.Albedo' from RenderTarget to ShaderResource - ... - [DESTROY] Resource 'GBuffer.Albedo' -``` - -## Conclusion - -This proof of concept demonstrates the core principles of modern transient render graphs. The system automatically manages resource lifetimes, inserts synchronization barriers, builds dependency DAGs, and culls unused work—all from high-level declarative pass descriptions. - -The architecture is designed to be extended with real graphics API integration (D3D12, Vulkan) while maintaining the same high-level interface. diff --git a/Ghost.RenderGraph.Concept/RenderGraph.cs b/Ghost.RenderGraph.Concept/RenderGraph.cs index 3e8304e..f9185c8 100644 --- a/Ghost.RenderGraph.Concept/RenderGraph.cs +++ b/Ghost.RenderGraph.Concept/RenderGraph.cs @@ -1,3 +1,9 @@ +using Ghost.Core.Utilities; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Runtime.InteropServices; + namespace Ghost.RenderGraph.Concept; public class RenderGraph @@ -8,7 +14,6 @@ public class RenderGraph private readonly List _resources = new(); private readonly List _passes = new(); - // Use List instead of Dictionary since resource IDs are sequential (0, 1, 2, ...) private readonly List _resourceLifetimes = new(); private readonly List _currentResourceStates = new(); private readonly List _resourceToAllocationMap = new(); @@ -17,47 +22,66 @@ public class RenderGraph private readonly RenderGraphBlackboard _blackboard = new(); private readonly ResourceAllocator _allocator = new(); + // Batching and Sync + private readonly List _batches = new(); + private readonly Stack _batchPool = new(); + private int _fenceCounter = 0; + + // Pooled Collections for Compilation + private readonly Dictionary _resourceLastWriter = new(); + private readonly Dictionary> _resourceLastReaders = new(); + private readonly Dictionary _passToBatchMap = new(); + + // Pooled Lists for Passes + private readonly Stack> _resourceAccessListPool = new(); + private readonly Stack _resourceLifetimePool = new(); + + // Execution Plan (Pre-calculated to avoid LINQ in Execute) + private List[] _resourcesToCreate = Array.Empty>(); + private List[] _resourcesToDestroy = Array.Empty>(); + + public RenderGraphTextureHandle ImportTexture(string name, TextureDescriptor descriptor) { var handle = new RenderGraphTextureHandle(_resourceIdCounter++, name, descriptor, isImported: true); - _resources.Add(handle); - _resourceLifetimes.Add(new ResourceLifetime(handle)); + _resources.Add(handle._handle); + _resourceLifetimes.Add(RentResourceLifetime(handle._handle)); _currentResourceStates.Add(ResourceState.Undefined); - _resourceToAllocationMap.Add(-1); // -1 means no allocation - Console.WriteLine($"[RG] Import Texture: '{name}' ({descriptor.Width}x{descriptor.Height}, {descriptor.Format})"); + _resourceToAllocationMap.Add(-1); + //ConsoleAPI.WriteLine($"[RG] Import Texture: '{name}' ({descriptor.Width}x{descriptor.Height}, {descriptor.Format})"); return handle; } public RenderGraphBufferHandle ImportBuffer(string name, BufferDescriptor descriptor) { var handle = new RenderGraphBufferHandle(_resourceIdCounter++, name, descriptor, isImported: true); - _resources.Add(handle); - _resourceLifetimes.Add(new ResourceLifetime(handle)); + _resources.Add(handle._handle); + _resourceLifetimes.Add(RentResourceLifetime(handle._handle)); _currentResourceStates.Add(ResourceState.Undefined); _resourceToAllocationMap.Add(-1); - Console.WriteLine($"[RG] Import Buffer: '{name}' ({descriptor.SizeInBytes} bytes)"); + //ConsoleAPI.WriteLine($"[RG] Import Buffer: '{name}' ({descriptor.SizeInBytes} bytes)"); return handle; } internal RenderGraphTextureHandle CreateTransientTexture(TextureDescriptor descriptor) { var handle = new RenderGraphTextureHandle(_resourceIdCounter++, descriptor.DebugName, descriptor, isImported: false); - _resources.Add(handle); - _resourceLifetimes.Add(new ResourceLifetime(handle)); + _resources.Add(handle._handle); + _resourceLifetimes.Add(RentResourceLifetime(handle._handle)); _currentResourceStates.Add(ResourceState.Undefined); _resourceToAllocationMap.Add(-1); - Console.WriteLine($"[RG] Create Transient Texture: '{descriptor.DebugName}' ({descriptor.Width}x{descriptor.Height}, {descriptor.Format})"); + //ConsoleAPI.WriteLine($"[RG] Create Transient Texture: '{descriptor.DebugName}' ({descriptor.Width}x{descriptor.Height}, {descriptor.Format})"); return handle; } internal RenderGraphBufferHandle CreateTransientBuffer(BufferDescriptor descriptor) { var handle = new RenderGraphBufferHandle(_resourceIdCounter++, descriptor.DebugName, descriptor, isImported: false); - _resources.Add(handle); - _resourceLifetimes.Add(new ResourceLifetime(handle)); + _resources.Add(handle._handle); + _resourceLifetimes.Add(RentResourceLifetime(handle._handle)); _currentResourceStates.Add(ResourceState.Undefined); _resourceToAllocationMap.Add(-1); - Console.WriteLine($"[RG] Create Transient Buffer: '{descriptor.DebugName}' ({descriptor.SizeInBytes} bytes)"); + //ConsoleAPI.WriteLine($"[RG] Create Transient Buffer: '{descriptor.DebugName}' ({descriptor.SizeInBytes} bytes)"); return handle; } @@ -76,7 +100,8 @@ public class RenderGraph public RenderGraphPassBuilder AddRenderPass(string name, out TPassData passData) where TPassData : class, new() { - var builder = new RenderGraphPassBuilder(this, name, _passCounter); + var list = RentResourceAccessList(); + var builder = new RenderGraphPassBuilder(this, name, _passCounter, list); passData = builder.PassData; return builder; } @@ -89,44 +114,126 @@ public class RenderGraph throw new InvalidOperationException($"Pass '{name}' has no render function set. Call SetRenderFunc() on the builder."); } - var pass = new RenderGraphPass( - name, - _passCounter++, - builder.PassData, - builder.RenderFunc, - builder.ResourceAccesses.ToList(), - builder.AllowCulling); + // Optimization: Use Pass Pool + RenderGraphPass? pass; + // Cast ReadOnlyList back to List (safe because we created it in AddRenderPass) + var resourceList = (List<(RenderGraphResourceHandle handle, ResourceState state)>)builder.ResourceAccesses; + + if (!RenderGraphPassPool.Pool.TryPop(out pass)) + { + pass = new RenderGraphPass( + name, + _passCounter++, + builder.QueueType, + builder.PassData, + builder.RenderFunc, + resourceList, + builder.AllowCulling); + } + else + { + pass.Initialize( + name, + _passCounter++, + builder.QueueType, + builder.PassData, + builder.RenderFunc, + resourceList, + builder.AllowCulling); + } _passes.Add(pass); foreach (var (handle, state) in pass.ResourceAccesses) { - _resourceLifetimes[handle.Id].AddUsage(state, pass.Index); + var lifeTime = _resourceLifetimes[handle.Id]; + lifeTime.AddUsage(state, pass.Index); + _resourceLifetimes[handle.Id] = lifeTime; } - Console.WriteLine($"[RG] Add Pass: '{name}' (Index: {pass.Index})"); - foreach (var (handle, state) in pass.ResourceAccesses) - { - Console.WriteLine($" - {state}: '{handle.Name}'"); - } + //ConsoleAPI.WriteLine($"[RG] Add Pass: '{name}' (Index: {pass.Index})"); } public void Compile() { - Console.WriteLine("\n[RG] ========== COMPILING RENDER GRAPH =========="); + //ConsoleAPI.WriteLine("\n[RG] ========== COMPILING RENDER GRAPH =========="); BuildDependencies(); CullUnusedPasses(); AnalyzeResourceLifetimes(); AllocatePhysicalResources(); + InsertSynchronization(); + } + + private void InsertSynchronization() + { + //ConsoleAPI.WriteLine("\n[RG] Building command batches and synchronization..."); + + _batches.Clear(); + _fenceCounter = 0; + + // 1. Create Batches (Topological grouping) + RenderGraphBatch? currentBatch = null; + _passToBatchMap.Clear(); + + foreach (var pass in _passes) + { + if (pass.RefCount == 0) continue; + + if (currentBatch == null || currentBatch.QueueType != pass.QueueType) + { + if (!_batchPool.TryPop(out currentBatch)) + { + currentBatch = new RenderGraphBatch(); + } + currentBatch.Initialize(_batches.Count, pass.QueueType); + _batches.Add(currentBatch); + } + + currentBatch.Passes.Add(pass); + _passToBatchMap[pass.Index] = currentBatch; + } + + //ConsoleAPI.WriteLine($" Created {_batches.Count} batches."); + + // 2. Inject Synchronization (Fences) + foreach (var batch in _batches) + { + foreach (var pass in batch.Passes) + { + foreach (var depIndex in pass.Dependencies) + { + if (_passToBatchMap.TryGetValue(depIndex, out var dependencyBatch)) + { + if (dependencyBatch != batch) + { + int fenceId; + if (dependencyBatch.SignalFences.Count == 0) + { + fenceId = _fenceCounter++; + dependencyBatch.SignalFences.Add(fenceId); + } + else + { + fenceId = dependencyBatch.SignalFences[0]; + } + + if (!batch.WaitFences.Contains(fenceId)) + { + batch.WaitFences.Add(fenceId); + //ConsoleAPI.WriteLine($" Batch {batch.ID} ({batch.QueueType}) waits on Batch {dependencyBatch.ID} ({dependencyBatch.QueueType}) [Fence {fenceId}]"); + } + } + } + } + } + } } private void AllocatePhysicalResources() { - // Pass as IReadOnlyList since it's now a List _allocator.AllocateResources(_resourceLifetimes, _passes); - // Build mapping from virtual resource to physical allocation foreach (var allocation in _allocator.Allocations) { foreach (var resource in allocation.AliasedResources) @@ -138,42 +245,59 @@ public class RenderGraph private void BuildDependencies() { - Console.WriteLine("\n[RG] Building pass dependencies..."); + _resourceLastWriter.Clear(); + foreach (var list in _resourceLastReaders.Values) list.Clear(); + _resourceLastReaders.Clear(); for (int i = 0; i < _passes.Count; i++) { var pass = _passes[i]; - var writtenResources = pass.ResourceAccesses - .Where(access => IsWriteState(access.state)) - .Select(access => access.handle.Id) - .ToHashSet(); - - for (int j = 0; j < i; j++) + foreach (var (handle, state) in pass.ResourceAccesses) { - var previousPass = _passes[j]; - - var hasReadAfterWrite = previousPass.ResourceAccesses - .Where(access => IsWriteState(access.state)) - .Any(access => pass.ResourceAccesses.Any( - current => current.handle.Id == access.handle.Id && IsReadState(current.state))); + int resourceId = handle.Id; - var hasWriteAfterRead = pass.ResourceAccesses - .Where(access => IsWriteState(access.state)) - .Any(access => previousPass.ResourceAccesses.Any( - prev => prev.handle.Id == access.handle.Id && IsReadState(prev.state))); - - var hasWriteAfterWrite = previousPass.ResourceAccesses - .Where(access => IsWriteState(access.state)) - .Any(access => writtenResources.Contains(access.handle.Id)); - - if (hasReadAfterWrite || hasWriteAfterRead || hasWriteAfterWrite) + if (IsReadState(state)) { - if (!pass.Dependencies.Contains(j)) + if (_resourceLastWriter.TryGetValue(resourceId, out int lastWriterIndex)) { - pass.Dependencies.Add(j); - Console.WriteLine($" Pass '{pass.Name}' depends on '{previousPass.Name}'"); + if (!pass.Dependencies.Contains(lastWriterIndex)) + { + pass.Dependencies.Add(lastWriterIndex); + } } + + if (!_resourceLastReaders.TryGetValue(resourceId, out var readers)) + { + readers = new List(); // Optimization TODO: Pool these + _resourceLastReaders[resourceId] = readers; + } + readers.Add(i); + } + + if (IsWriteState(state)) + { + if (_resourceLastWriter.TryGetValue(resourceId, out int lastWriterIndex)) + { + if (!pass.Dependencies.Contains(lastWriterIndex)) + { + pass.Dependencies.Add(lastWriterIndex); + } + } + + if (_resourceLastReaders.TryGetValue(resourceId, out var readers)) + { + foreach (var readerIndex in readers) + { + if (readerIndex != i && !pass.Dependencies.Contains(readerIndex)) + { + pass.Dependencies.Add(readerIndex); + } + } + readers.Clear(); + } + + _resourceLastWriter[resourceId] = i; } } } @@ -181,9 +305,6 @@ public class RenderGraph private void CullUnusedPasses() { - Console.WriteLine("\n[RG] Culling unused passes..."); - - // Mark passes that contribute to imported resources or don't allow culling foreach (var pass in _passes) { foreach (var (handle, _) in pass.ResourceAccesses) @@ -194,15 +315,12 @@ public class RenderGraph } } - // Mark passes that don't allow culling (synchronization, debug, etc.) if (!pass.AllowCulling) { pass.RefCount++; - Console.WriteLine($" Pass '{pass.Name}' marked as non-cullable"); } } - // Propagate reference counts through dependencies bool changed = true; while (changed) { @@ -223,82 +341,94 @@ public class RenderGraph } } } - - var culledPasses = _passes.Where(p => p.RefCount == 0 && p.AllowCulling).ToList(); - if (culledPasses.Count != 0) - { - foreach (var pass in culledPasses) - { - Console.WriteLine($" Culled unused pass: '{pass.Name}'"); - } - } - else - { - Console.WriteLine(" No passes culled."); - } } private void AnalyzeResourceLifetimes() { - Console.WriteLine("\n[RG] Resource lifetimes:"); + // Resize execution plan arrays if needed + int requiredSize = _passes.Count; + if (_resourcesToCreate.Length < requiredSize) + { + Array.Resize(ref _resourcesToCreate, requiredSize); + Array.Resize(ref _resourcesToDestroy, requiredSize); + + // Initialize new elements + for (int i = 0; i < requiredSize; i++) + { + if (_resourcesToCreate[i] == null) _resourcesToCreate[i] = new List(); + if (_resourcesToDestroy[i] == null) _resourcesToDestroy[i] = new List(); + } + } + // Clear previous plan + for (int i = 0; i < requiredSize; i++) + { + _resourcesToCreate[i].Clear(); + _resourcesToDestroy[i].Clear(); + } + + // Populate plan foreach (var lifetime in _resourceLifetimes) { - if (lifetime.FirstUse == int.MaxValue) + if (lifetime.FirstUse != int.MaxValue && !lifetime.Handle.IsImported) { - Console.WriteLine($" '{lifetime.Handle.Name}': UNUSED"); - } - else - { - var passNames = _passes - .Where(p => p.Index >= lifetime.FirstUse && p.Index <= lifetime.LastUse && p.RefCount > 0) - .Select(p => p.Name); - Console.WriteLine($" '{lifetime.Handle.Name}': [{lifetime.FirstUse}..{lifetime.LastUse}] ({string.Join(", ", passNames)})"); + // Verify bounds to be safe + if (lifetime.FirstUse < requiredSize) + _resourcesToCreate[lifetime.FirstUse].Add(lifetime.Handle); + + if (lifetime.LastUse < requiredSize) + _resourcesToDestroy[lifetime.LastUse].Add(lifetime.Handle); } } } public void Execute() { - Console.WriteLine("\n[RG] ========== EXECUTING RENDER GRAPH ==========\n"); + //ConsoleAPI.WriteLine("\n[RG] ========== EXECUTING RENDER GRAPH ==========\n"); var commandBuffer = new SimulatedCommandBuffer(); - foreach (var pass in _passes.Where(p => p.RefCount > 0).OrderBy(p => p.Index)) + foreach (var batch in _batches) { - Console.WriteLine($"[PASS {pass.Index}] Executing: '{pass.Name}'"); - - var lifetime = _resourceLifetimes - .Where(lt => lt.FirstUse == pass.Index) - .ToList(); + //ConsoleAPI.WriteLine($"[BATCH {batch.ID}] Queue: {batch.QueueType} | Passes: {batch.Passes.Count}"); - foreach (var lt in lifetime) + foreach (var fenceId in batch.WaitFences) { - if (!lt.Handle.IsImported) + //ConsoleAPI.WriteLine($" [SYNC] Wait for Fence {fenceId}"); + } + + foreach (var pass in batch.Passes) + { + //ConsoleAPI.WriteLine($" [PASS {pass.Index}] Executing: '{pass.Name}'"); + + // Optimized: Use pre-calculated lists + var createList = _resourcesToCreate[pass.Index]; + foreach (var handle in createList) { - CreateResource(lt.Handle); + CreateResource(handle); + } + + InsertBarriers(pass, commandBuffer); + + commandBuffer.BeginRenderPass(pass.Name); + pass.Execute(commandBuffer); + commandBuffer.EndRenderPass(); + + // Optimized: Use pre-calculated lists + var destroyList = _resourcesToDestroy[pass.Index]; + foreach (var handle in destroyList) + { + DestroyResource(handle); } } - InsertBarriers(pass, commandBuffer); - - commandBuffer.BeginRenderPass(pass.Name); - pass.Execute(commandBuffer); - commandBuffer.EndRenderPass(); - - var endLifetime = _resourceLifetimes - .Where(lt => lt.LastUse == pass.Index && !lt.Handle.IsImported) - .ToList(); - - foreach (var lt in endLifetime) + foreach (var fenceId in batch.SignalFences) { - DestroyResource(lt.Handle); + //ConsoleAPI.WriteLine($" [SYNC] Signal Fence {fenceId}"); } - - Console.WriteLine(); } - Console.WriteLine("[RG] ========== EXECUTION COMPLETE ==========\n"); + //ConsoleAPI.WriteLine("[RG] ========== EXECUTION COMPLETE ==========\n"); } private void CreateResource(RenderGraphResourceHandle handle) @@ -306,34 +436,7 @@ public class RenderGraph var allocation = _allocator.GetAllocation(handle); if (allocation != null) { - if (handle is RenderGraphTextureHandle textureHandle) - { - var desc = textureHandle.Descriptor; - Console.WriteLine($" [CREATE] Texture '{handle.Name}' using '{allocation.DebugName}' " + - $"({desc.Width}x{desc.Height}, {desc.Format}, offset: {allocation.OffsetInBytes})"); - } - else if (handle is RenderGraphBufferHandle bufferHandle) - { - var desc = bufferHandle.Descriptor; - Console.WriteLine($" [CREATE] Buffer '{handle.Name}' using '{allocation.DebugName}' " + - $"({desc.SizeInBytes} bytes, offset: {allocation.OffsetInBytes})"); - } - - // Note: We do NOT set _allocationActiveResource here - // That happens in InsertBarriers when the resource is first accessed - } - else - { - if (handle is RenderGraphTextureHandle textureHandle) - { - var desc = textureHandle.Descriptor; - Console.WriteLine($" [CREATE] Texture '{handle.Name}' ({desc.Width}x{desc.Height}, {desc.Format})"); - } - else if (handle is RenderGraphBufferHandle bufferHandle) - { - var desc = bufferHandle.Descriptor; - Console.WriteLine($" [CREATE] Buffer '{handle.Name}' ({desc.SizeInBytes} bytes)"); - } + // Logic... } _currentResourceStates[handle.Id] = ResourceState.Undefined; @@ -341,47 +444,50 @@ public class RenderGraph private void DestroyResource(RenderGraphResourceHandle handle) { - Console.WriteLine($" [DESTROY] Resource '{handle.Name}'"); _currentResourceStates[handle.Id] = ResourceState.Undefined; - - // Note: We intentionally DO NOT clear _allocationActiveResource here - // The allocation remains "owned" by this resource until another resource aliases it - // This allows us to track aliasing barriers correctly } private void InsertBarriers(RenderGraphPass pass, ICommandBuffer commandBuffer) { + var _resourceBarriers = ListPool.Rent(); + var _aliasingBarriers = ListPool.Rent(); + foreach (var (handle, targetState) in pass.ResourceAccesses) { - // Check if this resource shares a physical allocation var allocation = _allocator.GetAllocation(handle); if (allocation != null) { - // Check what resource is currently active on this allocation - if (_allocationActiveResource.TryGetValue(allocation.AllocationId, out var activeResource)) + if (_allocationActiveResource.TryGetValue(allocation.Value.AllocationId, out var activeResource)) { - // If a different resource is currently active on this allocation, insert aliasing barrier - if (activeResource != null && activeResource.Id != handle.Id) + if (activeResource != null && activeResource.Value.Id != handle.Id) { - commandBuffer.AliasingBarrier(activeResource.Name, handle.Name, allocation.DebugName); - - // Clear state for the old resource since it's being aliased away - _currentResourceStates[activeResource.Id] = ResourceState.Undefined; + _aliasingBarriers.Add(new AliasingBarrierInfo(activeResource.Value.Name, handle.Name, allocation.Value.DebugName)); + _currentResourceStates[activeResource.Value.Id] = ResourceState.Undefined; + } } - } - - // Update the active resource for this allocation - _allocationActiveResource[allocation.AllocationId] = handle; + _allocationActiveResource[allocation.Value.AllocationId] = handle; } var currentState = _currentResourceStates[handle.Id]; - if (currentState != targetState) { - commandBuffer.ResourceBarrier(handle.Name, currentState, targetState); + _resourceBarriers.Add(new ResourceBarrierInfo(handle.Name, currentState, targetState)); _currentResourceStates[handle.Id] = targetState; } } + + if (_aliasingBarriers.Count > 0) + { + commandBuffer.AliasingBarrier(System.Runtime.InteropServices.CollectionsMarshal.AsSpan(_aliasingBarriers)); + } + + if (_resourceBarriers.Count > 0) + { + commandBuffer.ResourceBarrier(System.Runtime.InteropServices.CollectionsMarshal.AsSpan(_resourceBarriers)); + } + + ListPool.Return(_resourceBarriers); + ListPool.Return(_aliasingBarriers); } private static bool IsWriteState(ResourceState state) @@ -399,17 +505,67 @@ public class RenderGraph state.HasFlag(ResourceState.CopySource); } + internal List<(RenderGraphResourceHandle, ResourceState)> RentResourceAccessList() + { + if (_resourceAccessListPool.TryPop(out var list)) + { + return list; + } + return new List<(RenderGraphResourceHandle, ResourceState)>(); + } + + internal void ReturnResourceAccessList(List<(RenderGraphResourceHandle, ResourceState)> list) + { + list.Clear(); + _resourceAccessListPool.Push(list); + } + + private ResourceLifetime RentResourceLifetime(RenderGraphResourceHandle handle) + { + if (!_resourceLifetimePool.TryPop(out var lifetime)) + { + lifetime = new ResourceLifetime(); + } + lifetime.Initialize(handle); + return lifetime; + } + public void Reset() { + foreach (var batch in _batches) + { + batch.Reset(); + _batchPool.Push(batch); + } + _batches.Clear(); + + foreach (var pass in _passes) + { + // ReturnResourceAccessList(pass.ResourceAccesses); + // Warning: pass.ResourceAccesses might be a copy in the current implementation of CommitPass? + // No, I'm going to fix CommitPass to use the pooled list. + // But right now builder.ResourceAccesses is a List. + // I need to ensure CommitPass takes ownership. + } _passes.Clear(); + _resources.Clear(); + foreach (var lifetime in _resourceLifetimes) + { + _resourceLifetimePool.Push(lifetime); + } _resourceLifetimes.Clear(); _currentResourceStates.Clear(); _resourceToAllocationMap.Clear(); _allocationActiveResource.Clear(); _blackboard.Clear(); + _allocator.Reset(); _passCounter = 0; _resourceIdCounter = 0; - Console.WriteLine("[RG] Render graph reset."); + + _resourceLastWriter.Clear(); + foreach (var list in _resourceLastReaders.Values) list.Clear(); + _resourceLastReaders.Clear(); + _passToBatchMap.Clear(); } } diff --git a/Ghost.RenderGraph.Concept/RenderGraphBatch.cs b/Ghost.RenderGraph.Concept/RenderGraphBatch.cs new file mode 100644 index 0000000..f524965 --- /dev/null +++ b/Ghost.RenderGraph.Concept/RenderGraphBatch.cs @@ -0,0 +1,33 @@ +using System.Collections.Generic; + +namespace Ghost.RenderGraph.Concept; + +internal class RenderGraphBatch +{ + public int ID { get; private set; } + public RenderQueueType QueueType { get; private set; } + public List Passes { get; } = new(); + + // Fences to wait on BEFORE executing this batch + public List WaitFences { get; } = new(); + + // Fences to signal AFTER executing this batch + public List SignalFences { get; } = new(); + + public RenderGraphBatch() + { + } + + public void Initialize(int id, RenderQueueType queueType) + { + ID = id; + QueueType = queueType; + } + + public void Reset() + { + Passes.Clear(); + WaitFences.Clear(); + SignalFences.Clear(); + } +} diff --git a/Ghost.RenderGraph.Concept/RenderGraphExtensions.cs b/Ghost.RenderGraph.Concept/RenderGraphExtensions.cs index 672a635..8dbf01e 100644 --- a/Ghost.RenderGraph.Concept/RenderGraphExtensions.cs +++ b/Ghost.RenderGraph.Concept/RenderGraphExtensions.cs @@ -1,41 +1,45 @@ +/* namespace Ghost.RenderGraph.Concept; public static class RenderGraphExtensions { - public static RenderGraphPassBuilder AddRenderPass( - this RenderGraph renderGraph, - string name, - out TPassData passData, - Action> setup) - where TPassData : class, new() - { - var builder = renderGraph.AddRenderPass(name, out passData); - setup(builder); - builder.Dispose(); - return builder; - } + // Cannot use RenderGraphPassBuilder in Action<> because it is a ref struct + // public static RenderGraphPassBuilder AddRenderPass( + // this RenderGraph renderGraph, + // string name, + // out TPassData passData, + // Action> setup) + // where TPassData : class, new() + // { + // var builder = renderGraph.AddRenderPass(name, out passData); + // setup(builder); + // builder.Dispose(); + // return builder; + // } } public sealed class RenderGraphPassScope : IDisposable where TPassData : class, new() { - private readonly RenderGraphPassBuilder _builder; + // Cannot hold ref struct in class + // private readonly RenderGraphPassBuilder _builder; private readonly string _passName; - internal RenderGraphPassScope(RenderGraphPassBuilder builder, string passName) - { - _builder = builder; - _passName = passName; - } + // internal RenderGraphPassScope(RenderGraphPassBuilder builder, string passName) + // { + // _builder = builder; + // _passName = passName; + // } - public RenderGraphPassBuilder Builder => _builder; + // public RenderGraphPassBuilder Builder => _builder; public void Dispose() { // Commit the pass when the using block ends - if (_builder.RenderFunc != null) - { - _builder.Dispose(); - } + // if (_builder.RenderFunc != null) + // { + // _builder.Dispose(); + // } } } +*/ diff --git a/Ghost.RenderGraph.Concept/RenderGraphPass.cs b/Ghost.RenderGraph.Concept/RenderGraphPass.cs index e964808..1b460c8 100644 --- a/Ghost.RenderGraph.Concept/RenderGraphPass.cs +++ b/Ghost.RenderGraph.Concept/RenderGraphPass.cs @@ -1,50 +1,111 @@ +using System; +using System.Collections.Generic; + namespace Ghost.RenderGraph.Concept; +public enum RenderQueueType +{ + Graphics, + Compute, + AsyncCompute, + Copy +} + internal abstract class RenderGraphPass { - public string Name { get; } - public int Index { get; } - public List<(RenderGraphResourceHandle handle, ResourceState state)> ResourceAccesses { get; } + public string Name { get; set; } = string.Empty; + public int Index { get; set; } + public RenderQueueType QueueType { get; set; } + public List<(RenderGraphResourceHandle handle, ResourceState state)> ResourceAccesses { get; set; } public List Dependencies { get; } = new(); public int RefCount { get; set; } = 0; - public bool AllowCulling { get; } + public bool AllowCulling { get; set; } protected RenderGraphPass( string name, int index, + RenderQueueType queueType, List<(RenderGraphResourceHandle handle, ResourceState state)> resourceAccesses, bool allowCulling) { Name = name; Index = index; + QueueType = queueType; ResourceAccesses = resourceAccesses; AllowCulling = allowCulling; } + protected void InitializeBase( + string name, + int index, + RenderQueueType queueType, + List<(RenderGraphResourceHandle handle, ResourceState state)> resourceAccesses, + bool allowCulling) + { + Name = name; + Index = index; + QueueType = queueType; + ResourceAccesses = resourceAccesses; + AllowCulling = allowCulling; + Dependencies.Clear(); + RefCount = 0; + } + public abstract void Execute(ICommandBuffer commandBuffer); + public abstract void Release(); +} + +internal static class RenderGraphPassPool + where TPassData : class +{ + public static readonly Stack> Pool = new(); } internal class RenderGraphPass : RenderGraphPass where TPassData : class { - public TPassData PassData { get; } - public Action RenderFunc { get; } + public TPassData PassData { get; private set; } + public Action RenderFunc { get; private set; } public RenderGraphPass( string name, int index, + RenderQueueType queueType, TPassData passData, Action renderFunc, List<(RenderGraphResourceHandle handle, ResourceState state)> resourceAccesses, bool allowCulling) - : base(name, index, resourceAccesses, allowCulling) + : base(name, index, queueType, resourceAccesses, allowCulling) { PassData = passData; RenderFunc = renderFunc; } + public void Initialize( + string name, + int index, + RenderQueueType queueType, + TPassData passData, + Action renderFunc, + List<(RenderGraphResourceHandle handle, ResourceState state)> resourceAccesses, + bool allowCulling) + { + InitializeBase(name, index, queueType, resourceAccesses, allowCulling); + PassData = passData; + RenderFunc = renderFunc; + } + public override void Execute(ICommandBuffer commandBuffer) { RenderFunc(PassData, commandBuffer); } + + public override void Release() + { + PassData = null!; + RenderFunc = null!; + // ResourceAccesses list ownership is transferred back to RenderGraph + ResourceAccesses = null!; + RenderGraphPassPool.Pool.Push(this); + } } diff --git a/Ghost.RenderGraph.Concept/RenderGraphPassBuilder.cs b/Ghost.RenderGraph.Concept/RenderGraphPassBuilder.cs index 584fa50..c2c8446 100644 --- a/Ghost.RenderGraph.Concept/RenderGraphPassBuilder.cs +++ b/Ghost.RenderGraph.Concept/RenderGraphPassBuilder.cs @@ -11,46 +11,53 @@ public interface IRenderGraphBuilder RenderGraphBufferHandle CreateBuffer(BufferDescriptor descriptor); } -public class RenderGraphPassBuilder : IRenderGraphBuilder, IDisposable +public ref struct RenderGraphPassBuilder where TPassData : class, new() { private readonly RenderGraph _graph; private readonly string _passName; private readonly int _passIndex; - private readonly List<(RenderGraphResourceHandle handle, ResourceState state)> _resourceAccesses = new(); + private RenderQueueType _queueType; + private readonly List<(RenderGraphResourceHandle handle, ResourceState state)> _resourceAccesses; private Action? _renderFunc; private bool _committed; - private bool _allowCulling = true; + private bool _allowCulling; public TPassData PassData { get; } - internal RenderGraphPassBuilder(RenderGraph graph, string passName, int passIndex) + internal RenderGraphPassBuilder(RenderGraph graph, string passName, int passIndex, List<(RenderGraphResourceHandle handle, ResourceState state)> resourceAccesses) { _graph = graph; _passName = passName; _passIndex = passIndex; PassData = new TPassData(); + _resourceAccesses = resourceAccesses; + _queueType = RenderQueueType.Graphics; + _allowCulling = true; + _committed = false; + _renderFunc = null; } internal IReadOnlyList<(RenderGraphResourceHandle handle, ResourceState state)> ResourceAccesses => _resourceAccesses; + internal RenderQueueType QueueType => _queueType; internal Action? RenderFunc => _renderFunc; internal bool AllowCulling => _allowCulling; public RenderGraphTextureHandle ReadTexture(RenderGraphTextureHandle handle) { - _resourceAccesses.Add((handle, ResourceState.ShaderResource)); + _resourceAccesses.Add((handle._handle, ResourceState.ShaderResource)); return handle; } public RenderGraphTextureHandle WriteTexture(RenderGraphTextureHandle handle) { - _resourceAccesses.Add((handle, ResourceState.RenderTarget)); + _resourceAccesses.Add((handle._handle, ResourceState.RenderTarget)); return handle; } public RenderGraphTextureHandle UseDepthBuffer(RenderGraphTextureHandle handle, bool writeAccess) { - _resourceAccesses.Add((handle, writeAccess ? ResourceState.DepthWrite : ResourceState.DepthRead)); + _resourceAccesses.Add((handle._handle, writeAccess ? ResourceState.DepthWrite : ResourceState.DepthRead)); return handle; } @@ -62,13 +69,13 @@ public class RenderGraphPassBuilder : IRenderGraphBuilder, IDisposabl public RenderGraphBufferHandle ReadBuffer(RenderGraphBufferHandle handle) { - _resourceAccesses.Add((handle, ResourceState.ShaderResource)); + _resourceAccesses.Add((handle._handle, ResourceState.ShaderResource)); return handle; } public RenderGraphBufferHandle WriteBuffer(RenderGraphBufferHandle handle) { - _resourceAccesses.Add((handle, ResourceState.UnorderedAccess)); + _resourceAccesses.Add((handle._handle, ResourceState.UnorderedAccess)); return handle; } @@ -78,9 +85,16 @@ public class RenderGraphPassBuilder : IRenderGraphBuilder, IDisposabl return handle; } - public void SetRenderFunc(Action renderFunc) + public void SetRenderFunc(Action renderFunc) { - _renderFunc = renderFunc; + _queueType = RenderQueueType.Graphics; + _renderFunc = (data, cmd) => renderFunc(data, new RasterRenderContext(cmd)); + } + + public void SetComputeFunc(Action computeFunc, bool asyncCompute = false) + { + _queueType = asyncCompute ? RenderQueueType.AsyncCompute : RenderQueueType.Compute; + _renderFunc = (data, cmd) => computeFunc(data, new ComputeRenderContext(cmd)); } /// @@ -93,6 +107,7 @@ public class RenderGraphPassBuilder : IRenderGraphBuilder, IDisposabl _allowCulling = allowCulling; } + public void Dispose() { // Commit the pass when disposed (at end of using block) diff --git a/Ghost.RenderGraph.Concept/RenderGraphResourceHandle.cs b/Ghost.RenderGraph.Concept/RenderGraphResourceHandle.cs index fa6561b..20f06c6 100644 --- a/Ghost.RenderGraph.Concept/RenderGraphResourceHandle.cs +++ b/Ghost.RenderGraph.Concept/RenderGraphResourceHandle.cs @@ -1,41 +1,63 @@ +using System.Runtime.InteropServices; + namespace Ghost.RenderGraph.Concept; -public class RenderGraphResourceHandle +public struct RenderGraphResourceHandle { + [StructLayout(LayoutKind.Explicit)] + internal struct descriptor_union + { + [FieldOffset(0)] + public TextureDescriptor texture; + [FieldOffset(0)] + public BufferDescriptor buffer; + } + internal int Id { get; } internal ResourceType Type { get; } internal string Name { get; } internal bool IsImported { get; } + internal descriptor_union Descriptor { get; } - internal RenderGraphResourceHandle(int id, ResourceType type, string name, bool isImported) + internal RenderGraphResourceHandle(int id, ResourceType type, string name, bool isImported, descriptor_union descriptor) { Id = id; Type = type; Name = name; IsImported = isImported; + Descriptor = descriptor; } public override string ToString() => Name; } -public sealed class RenderGraphTextureHandle : RenderGraphResourceHandle +public struct RenderGraphTextureHandle { - internal TextureDescriptor Descriptor { get; } + internal readonly RenderGraphResourceHandle _handle; + + internal int Id => _handle.Id; + internal ResourceType Type => _handle.Type; + internal string Name => _handle.Name; + internal bool IsImported => _handle.IsImported; internal RenderGraphTextureHandle(int id, string name, TextureDescriptor descriptor, bool isImported) - : base(id, ResourceType.Texture, name, isImported) { - Descriptor = descriptor; + _handle = new RenderGraphResourceHandle(id, ResourceType.Texture, name, isImported, new RenderGraphResourceHandle.descriptor_union() { texture = descriptor }); } } -public sealed class RenderGraphBufferHandle : RenderGraphResourceHandle +public struct RenderGraphBufferHandle { + internal readonly RenderGraphResourceHandle _handle; + internal BufferDescriptor Descriptor { get; } + internal int Id => _handle.Id; + internal ResourceType Type => _handle.Type; + internal string Name => _handle.Name; + internal bool IsImported => _handle.IsImported; internal RenderGraphBufferHandle(int id, string name, BufferDescriptor descriptor, bool isImported) - : base(id, ResourceType.Buffer, name, isImported) { - Descriptor = descriptor; + _handle = new RenderGraphResourceHandle(id, ResourceType.Buffer, name, isImported, new RenderGraphResourceHandle.descriptor_union() { buffer = descriptor }); } } diff --git a/Ghost.RenderGraph.Concept/ResourceAllocator.cs b/Ghost.RenderGraph.Concept/ResourceAllocator.cs index 228511b..2abbe64 100644 --- a/Ghost.RenderGraph.Concept/ResourceAllocator.cs +++ b/Ghost.RenderGraph.Concept/ResourceAllocator.cs @@ -1,9 +1,12 @@ +using Ghost.Core.Utilities; +using ZLinq; + namespace Ghost.RenderGraph.Concept; /// /// Represents a physical memory allocation that can be shared by multiple transient resources /// -internal class PhysicalResourceAllocation +internal struct PhysicalResourceAllocation { public int AllocationId { get; } public ulong SizeInBytes { get; } @@ -28,6 +31,12 @@ internal class ResourceAllocator private readonly List _allocations = new(); private int _allocationIdCounter = 0; + public void Reset() + { + _allocations.Clear(); + _allocationIdCounter = 0; + } + public IReadOnlyList Allocations => _allocations; /// @@ -37,26 +46,27 @@ internal class ResourceAllocator IReadOnlyList resourceLifetimes, List passes) { - Console.WriteLine("\n[RG] ===== RESOURCE ALIASING ANALYSIS ====="); + //ConsoleAPI.WriteLine("\n[RG] ===== RESOURCE ALIASING ANALYSIS ====="); // Separate imported and transient resources // Sort by SIZE FIRST (descending), then by FIRST USE (ascending) // This allows smaller resources (A, B) to alias into larger resources' (C) space // Example: C=10MB[1..2], A=4MB[0..1], B=6MB[0..1] → Allocate C first, then A and B alias into C's space - var transientResources = resourceLifetimes + + // TODO: Avoid linq for performance-critical path + var transientResources = resourceLifetimes.AsValueEnumerable() .Where(lt => !lt.Handle.IsImported && lt.FirstUse != int.MaxValue) .OrderByDescending(lt => GetResourceSize(lt.Handle)) - .ThenBy(lt => lt.FirstUse) - .ToList(); + .ThenBy(lt => lt.FirstUse).ToArray(); - if (!transientResources.Any()) + if (transientResources.Length == 0) { - Console.WriteLine("No transient resources to allocate."); + //ConsoleAPI.WriteLine("No transient resources to allocate."); return; } // Track which allocation slots are occupied at each pass - var allocationSlots = new List(); + var allocationSlots = Core.Utilities.ListPool.Rent(); foreach (var resource in transientResources) { @@ -83,9 +93,7 @@ internal class ResourceAllocator ulong offsetInAllocation = reuseSlot.FindFreeOffset(size, alignment, resource); reuseSlot.AddResource(resource, offsetInAllocation, size); - Console.WriteLine($"[ALIAS] '{resource.Handle.Name}' aliases with '{reuseSlot.Allocation.DebugName}' " + - $"(heap offset: {reuseSlot.Allocation.OffsetInBytes}, resource offset: {offsetInAllocation}, size: {size} bytes, " + - $"lifetime: [{resource.FirstUse}..{resource.LastUse}])"); + //ConsoleAPI.WriteLine($"[ALIAS] '{resource.Handle.Name}' aliases with '{reuseSlot.Allocation.DebugName}' " + $"(heap offset: {reuseSlot.Allocation.OffsetInBytes}, resource offset: {offsetInAllocation}, size: {size} bytes, " + $"lifetime: [{resource.FirstUse}..{resource.LastUse}])"); } else { @@ -105,24 +113,28 @@ internal class ResourceAllocator newSlot.AddResource(resource, 0, size); // Offset 0 within this new allocation allocationSlots.Add(newSlot); - Console.WriteLine($"[ALLOC] '{resource.Handle.Name}' gets new allocation '{allocation.DebugName}' " + - $"(heap offset: {heapOffset}, size: {size} bytes, lifetime: [{resource.FirstUse}..{resource.LastUse}])"); + //ConsoleAPI.WriteLine($"[ALLOC] '{resource.Handle.Name}' gets new allocation '{allocation.DebugName}' " + $"(heap offset: {heapOffset}, size: {size} bytes, lifetime: [{resource.FirstUse}..{resource.LastUse}])"); } } - _allocations.AddRange(allocationSlots.Select(s => s.Allocation)); + foreach (var slot in allocationSlots) + { + _allocations.Add(slot.Allocation); + } + + ListPool.Return(allocationSlots); // Print summary - Console.WriteLine($"\n[RG] Memory Statistics:"); + //ConsoleAPI.WriteLine($"\n[RG] Memory Statistics:"); var totalWithoutAliasing = transientResources.Sum(r => (long)GetResourceSize(r.Handle)); var totalWithAliasing = _allocations.Sum(a => (long)a.SizeInBytes); var savedMemory = totalWithoutAliasing - totalWithAliasing; var savingPercentage = totalWithoutAliasing > 0 ? (savedMemory * 100.0 / totalWithoutAliasing) : 0; - Console.WriteLine($" Total memory without aliasing: {FormatBytes(totalWithoutAliasing)}"); - Console.WriteLine($" Total memory with aliasing: {FormatBytes(totalWithAliasing)}"); - Console.WriteLine($" Memory saved: {FormatBytes(savedMemory)} ({savingPercentage:F1}%)"); - Console.WriteLine($" Allocations: {_allocations.Count} physical allocations for {transientResources.Count} resources"); + //ConsoleAPI.WriteLine($" Total memory without aliasing: {FormatBytes(totalWithoutAliasing)}"); + //ConsoleAPI.WriteLine($" Total memory with aliasing: {FormatBytes(totalWithAliasing)}"); + //ConsoleAPI.WriteLine($" Memory saved: {FormatBytes(savedMemory)} ({savingPercentage:F1}%)"); + //ConsoleAPI.WriteLine($" Allocations: {_allocations.Count} physical allocations for {transientResources.Count()} resources"); } private bool CanAlias(AllocationSlot slot, ResourceLifetime resource, ulong requiredSize, ulong requiredAlignment) @@ -153,10 +165,10 @@ internal class ResourceAllocator private ulong GetResourceSize(RenderGraphResourceHandle handle) { - return handle switch + return handle.Type switch { - RenderGraphTextureHandle texture => CalculateTextureSize(texture.Descriptor), - RenderGraphBufferHandle buffer => (ulong)buffer.Descriptor.SizeInBytes, + ResourceType.Texture => CalculateTextureSize(handle.Descriptor.texture), + ResourceType.Buffer => (ulong)handle.Descriptor.buffer.SizeInBytes, _ => 0 }; } @@ -164,10 +176,10 @@ internal class ResourceAllocator private ulong GetResourceAlignment(RenderGraphResourceHandle handle) { // In a real implementation, this would query D3D12_RESOURCE_ALLOCATION_INFO - return handle switch + return handle.Type switch { - RenderGraphTextureHandle => 65536, // 64KB texture alignment (typical) - RenderGraphBufferHandle => 256, // 256 byte buffer alignment + ResourceType.Texture => 65536, // 64KB texture alignment (typical) + ResourceType.Buffer => 256, // 256 byte buffer alignment _ => 256 }; } @@ -199,7 +211,19 @@ internal class ResourceAllocator public PhysicalResourceAllocation? GetAllocation(RenderGraphResourceHandle handle) { - return _allocations.FirstOrDefault(a => a.AliasedResources.Any(r => r.Id == handle.Id)); + // return _allocations.FirstOrDefault(a => a.AliasedResources.Any(r => r.Id == handle.Id)); + foreach (var allocation in _allocations) + { + foreach (var aliased in allocation.AliasedResources) + { + if (aliased.Id == handle.Id) + { + return allocation; + } + } + } + + return null; } private class AllocationSlot @@ -230,19 +254,19 @@ internal class ResourceAllocator } // Sort regions by offset - var sortedRegions = _occupiedRegions.OrderBy(r => r.Offset).ToList(); + var sortedRegions = _occupiedRegions.AsValueEnumerable().OrderBy(r => r.Offset).ToArray(); // Try to fit at the beginning (offset 0) ulong candidateOffset = 0; bool fitsAtStart = true; - foreach (var region in sortedRegions) + foreach (var (Offset, Size, Resource) in sortedRegions) { // Check if this region overlaps with our candidate position - if (region.Offset < requiredSize) + if (Offset < requiredSize) { // Check lifetime - if no overlap, we can still use this space - if (LifetimesOverlap(region.Resource, newResource)) + if (LifetimesOverlap(Resource, newResource)) { fitsAtStart = false; break; @@ -256,7 +280,7 @@ internal class ResourceAllocator } // Try gaps between regions - for (int i = 0; i < sortedRegions.Count; i++) + for (int i = 0; i < sortedRegions.Length; i++) { var current = sortedRegions[i]; @@ -270,7 +294,7 @@ internal class ResourceAllocator candidateOffset = AlignUp(current.Offset + current.Size, alignment); // Check if it fits before the next region (or end of allocation) - ulong nextRegionStart = (i + 1 < sortedRegions.Count) + ulong nextRegionStart = (i + 1 < sortedRegions.Length) ? sortedRegions[i + 1].Offset : Allocation.SizeInBytes; @@ -278,7 +302,7 @@ internal class ResourceAllocator { // Check no lifetime conflicts with any regions in this range bool hasConflict = false; - for (int j = i + 1; j < sortedRegions.Count; j++) + for (int j = i + 1; j < sortedRegions.Length; j++) { var other = sortedRegions[j]; if (other.Offset < candidateOffset + requiredSize) @@ -299,7 +323,7 @@ internal class ResourceAllocator } // Try placing at the end - if (sortedRegions.Count > 0) + if (sortedRegions.Length > 0) { var last = sortedRegions[^1]; if (!LifetimesOverlap(last.Resource, newResource)) diff --git a/Ghost.RenderGraph.Concept/ResourceDescriptor.cs b/Ghost.RenderGraph.Concept/ResourceDescriptor.cs index 4f54b90..996e753 100644 --- a/Ghost.RenderGraph.Concept/ResourceDescriptor.cs +++ b/Ghost.RenderGraph.Concept/ResourceDescriptor.cs @@ -15,14 +15,14 @@ public enum TextureFormat R32Uint } -public record TextureDescriptor( +public record struct TextureDescriptor( int Width, int Height, TextureFormat Format, string DebugName = "Unnamed Texture" ); -public record BufferDescriptor( +public record struct BufferDescriptor( int SizeInBytes, string DebugName = "Unnamed Buffer" ); diff --git a/Ghost.RenderGraph.Concept/ResourceLifetime.cs b/Ghost.RenderGraph.Concept/ResourceLifetime.cs index cad392f..bae5362 100644 --- a/Ghost.RenderGraph.Concept/ResourceLifetime.cs +++ b/Ghost.RenderGraph.Concept/ResourceLifetime.cs @@ -1,6 +1,6 @@ namespace Ghost.RenderGraph.Concept; -internal class ResourceUsage +internal struct ResourceUsage { public RenderGraphResourceHandle Handle { get; } public ResourceState State { get; } @@ -14,16 +14,23 @@ internal class ResourceUsage } } -internal class ResourceLifetime +internal struct ResourceLifetime { - public RenderGraphResourceHandle Handle { get; } + public RenderGraphResourceHandle Handle { get; private set; } public int FirstUse { get; set; } = int.MaxValue; public int LastUse { get; set; } = -1; public List Usages { get; } = new(); - public ResourceLifetime(RenderGraphResourceHandle handle) + public ResourceLifetime() + { + } + + public void Initialize(RenderGraphResourceHandle handle) { Handle = handle; + FirstUse = int.MaxValue; + LastUse = -1; + Usages.Clear(); } public void AddUsage(ResourceState state, int passIndex) diff --git a/Ghost.RenderGraph.Concept/SIZE_FIRST_SORTING.md b/Ghost.RenderGraph.Concept/SIZE_FIRST_SORTING.md deleted file mode 100644 index c3e407c..0000000 --- a/Ghost.RenderGraph.Concept/SIZE_FIRST_SORTING.md +++ /dev/null @@ -1,160 +0,0 @@ -# Resource Allocator Improvements: Size-First Sorting - -## What Changed - -### Before: First-Use Then Size Sorting -```csharp -.OrderBy(lt => lt.FirstUse) -.ThenByDescending(lt => GetResourceSize(lt.Handle)) -``` - -**Order**: GBuffer.Albedo[0] → GBuffer.Normal[0] → GBuffer.Depth[0] → Lighting[1] → ... - -**Result**: Smaller resources allocated first, harder for larger resources to find space. - -### After: Size-First Then First-Use Sorting -```csharp -.OrderByDescending(lt => GetResourceSize(lt.Handle)) -.ThenBy(lt => lt.FirstUse) -``` - -**Order**: GBuffer.Normal(16.6MB) → LightingResult(16.6MB) → GBuffer.Albedo(8.3MB) → GBuffer.Depth(8.3MB) → ... - -**Result**: Larger resources get allocated first, smaller resources naturally alias into their space. - -## Benefits - -### 1. Better Aliasing for C > A and C > B, C < A+B Case - -**Scenario**: -- Resource A: 4MB, lifetime [0..1] -- Resource B: 6MB, lifetime [0..1] -- Resource C: 10MB, lifetime [2..3] - -**Old Sorting (First-Use)**: -``` -Pass 0-1: [A: 4MB] [B: 6MB] -Pass 2-3: [C: 10MB] ← NEW ALLOCATION (doesn't fit in A or B) -Total: 4MB + 6MB + 10MB = 20MB -``` - -**New Sorting (Size-First)**: -``` -Pass 0-1: [C's space: 10MB] ← Allocated first - [A: 4MB at offset 0] ← Aliases into C's space - [B: 6MB at offset 4MB] ← Aliases into C's space (or new if > 6MB left) -Pass 2-3: [C: 10MB] ← Reuses its original allocation -Total: 10MB (optimal!) -``` - -### 2. Improved Memory Savings - -**Current Demo Output**: -``` -[ALLOC] 'GBuffer.Normal' gets new allocation 'Physical_Texture_1' - (heap offset: 0, size: 16.6 MB, lifetime: [0..2]) -[ALLOC] 'LightingResult' gets new allocation 'Physical_Texture_2' - (heap offset: 16.6 MB, size: 16.6 MB, lifetime: [1..4]) -[ALIAS] 'TAA.Result' aliases with 'Physical_Texture_1' - (heap offset: 0, resource offset: 0, size: 16.6 MB, lifetime: [4..5]) -[ALLOC] 'GBuffer.Albedo' gets new allocation 'Physical_Texture_3' - (heap offset: 33.2 MB, size: 8.3 MB, lifetime: [0..1]) -[ALIAS] 'SSAO' aliases with 'Physical_Texture_3' - (heap offset: 33.2 MB, resource offset: 0, size: 8.3 MB, lifetime: [2..5]) -``` - -**Memory saved: 32.64 MB (40.7%)** - -### 3. Proper Heap Offset Calculation - -**New Feature**: Each physical allocation now has a correct heap offset: - -```csharp -// Calculate cumulative heap offset -ulong heapOffset = allocationSlots.Count > 0 - ? allocationSlots.Max(s => s.Allocation.OffsetInBytes + s.Allocation.SizeInBytes) - : 0; -``` - -**Visual Representation**: -``` -Heap Layout: -├─ [0 MB .. 16.6 MB] Physical_Texture_1 (GBuffer.Normal, TAA.Result) -├─ [16.6 MB .. 33.2 MB] Physical_Texture_2 (LightingResult) -├─ [33.2 MB .. 41.5 MB] Physical_Texture_3 (GBuffer.Albedo, SSAO) -└─ [41.5 MB .. 49.8 MB] Physical_Texture_4 (GBuffer.Depth, BloomDownsample) -``` - -### 4. Sub-Allocation Support - -**New Feature**: `AllocationSlot.FindFreeOffset()` can now find gaps within allocations: - -```csharp -public ulong FindFreeOffset(ulong requiredSize, ulong alignment, ResourceLifetime newResource) -{ - // Tries to fit resource: - // 1. At offset 0 (if no lifetime conflicts) - // 2. In gaps between existing resources - // 3. After the last resource - // 4. Returns 0 if no space (caller creates new allocation) -} -``` - -This enables **true sub-allocation** where multiple resources can share the same allocation at different offsets. - -## Real-World D3D12 Mapping - -```csharp -// Our simulated heap: -Physical_Texture_1 at heap offset 0 - -// Maps to D3D12: -ID3D12Heap* heap = d3d12ma->AllocateHeap(256MB); - -// Place resources: -device->CreatePlacedResource( - heap, - 0, // ← Our "heap offset: 0" - &gbufferNormalDesc, - D3D12_RESOURCE_STATE_COMMON, - nullptr, - IID_PPV_ARGS(&gbufferNormal)); - -// Later, alias: -device->CreatePlacedResource( - heap, - 0, // ← Same offset, aliased! - &taaResultDesc, - D3D12_RESOURCE_STATE_COMMON, - nullptr, - IID_PPV_ARGS(&taaResult)); - -// Insert aliasing barrier before using taaResult -barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_ALIASING; -barrier.Aliasing.pResourceBefore = gbufferNormal; -barrier.Aliasing.pResourceAfter = taaResult; -``` - -## Performance Impact - -### CPU -- Sorting: O(N log N) → No change -- Allocation: O(N × M) where M = slots → **Improved** (fewer slots due to better packing) - -### Memory -- **40.7% savings** in demo (32.64 MB saved) -- Scales better with mixed resource sizes - -### GPU -- Fewer physical allocations = less heap fragmentation -- Better cache locality (larger resources grouped together) - -## Conclusion - -By sorting resources **size-first**, we enable: -1. ✅ **Better handling of C > A, C > B, C < A+B scenarios** -2. ✅ **Proper heap offset tracking** -3. ✅ **Sub-allocation within physical allocations** -4. ✅ **Production-ready D3D12MA integration path** - -The allocator now matches industry-standard behavior from Unreal, Unity, and Frostbite! diff --git a/Ghost.Shader.Concept/ARCHITECTURE.md b/Ghost.Shader.Concept/ARCHITECTURE.md deleted file mode 100644 index d99750a..0000000 --- a/Ghost.Shader.Concept/ARCHITECTURE.md +++ /dev/null @@ -1,425 +0,0 @@ -# Architecture Design Document - - -- [Architecture Design Document](#architecture-design-document) - - [Ghost Shader Concept - Technical Deep Dive](#ghost-shader-concept-technical-deep-dive) - - [Overview](#overview) - - [Memory Layout & Cache Efficiency](#memory-layout-cache-efficiency) - - [KeywordSet (64 bytes, cache-line friendly)](#keywordset-64-bytes-cache-line-friendly) - - [MaterialPropertyBlock (Variable Size, GPU-aligned)](#materialpropertyblock-variable-size-gpu-aligned) - - [Variant Compilation & Caching](#variant-compilation-caching) - - [Two-Level Caching Strategy](#two-level-caching-strategy) - - [Batching Algorithm](#batching-algorithm) - - [Phase 1: Grouping (O(N))](#phase-1-grouping-on) - - [Phase 2: Sorting (O(K log K))](#phase-2-sorting-ok-log-k) - - [Thread Safety Model](#thread-safety-model) - - [Lock-Free Operations](#lock-free-operations) - - [Fine-Grained Locks](#fine-grained-locks) - - [Pass System Design](#pass-system-design) - - [Why Multi-Pass?](#why-multi-pass) - - [Per-Pass Overrides](#per-pass-overrides) - - [Keyword System Philosophy](#keyword-system-philosophy) - - [Global vs Local](#global-vs-local) - - [Performance Targets](#performance-targets) - - [Microbenchmarks](#microbenchmarks) - - [Real-World Expected](#real-world-expected) - - [Unsafe Code Justification](#unsafe-code-justification) - - [Where & Why](#where-why) - - [Safety Measures](#safety-measures) - - [Extension & Customization Points](#extension-customization-points) - - [1. Custom Property Types](#1-custom-property-types) - - [2. Custom Batching Logic](#2-custom-batching-logic) - - [3. Material Inheritance](#3-material-inheritance) - - [Comparison to Production Engines](#comparison-to-production-engines) - - [Unity URP (Scriptable Render Pipeline)](#unity-urp-scriptable-render-pipeline) - - [Unreal Engine 5](#unreal-engine-5) - - [Godot 4](#godot-4) - - [Future Optimizations](#future-optimizations) - - [1. GPU-Driven Rendering](#1-gpu-driven-rendering) - - [2. Parallel Compilation](#2-parallel-compilation) - - [3. Material LOD](#3-material-lod) - - [4. Texture Streaming](#4-texture-streaming) - - [Conclusion](#conclusion) - - -## Ghost Shader Concept - Technical Deep Dive - -### Overview - -This document explains the low-level design decisions and performance optimizations in the material system. - ---- - -## Memory Layout & Cache Efficiency - -### KeywordSet (64 bytes, cache-line friendly) - -``` -+-------------------+-------------------+ -| Global (32 bytes) | Local (32 bytes) | -+-------------------+-------------------+ -| 4 x ulong (256b) | 4 x ulong (256b) | -+-------------------+-------------------+ -``` - -**Design Rationale:** -- Fixed-size struct for stack allocation (no GC pressure) -- 64 bytes fits in single cache line on most CPUs -- Bitset operations are branchless (CPU-friendly) -- Supports 512 total keywords (256 global + 256 local) - -**Performance Characteristics:** -- Enable/Disable: ~0.1ns (single bitwise OR/AND) -- Hash: ~5ns (8 iterations × FNV-1a) -- Copy: ~1ns (memcpy 64 bytes) - -### MaterialPropertyBlock (Variable Size, GPU-aligned) - -``` -Properties stored as: [Prop1 (16-aligned)] [Prop2 (16-aligned)] ... -``` - -**Design Rationale:** -- 16-byte alignment matches GPU constant buffer requirements -- Linear memory layout for fast memcpy to GPU buffers -- Dynamic growth with 2x allocation strategy -- Dictionary for O(1) property lookup by name - -**Memory Overhead:** -- Per property: ~80 bytes (dict entry + metadata) -- Actual data: aligned size (e.g., float = 16 bytes, float4 = 16 bytes) - ---- - -## Variant Compilation & Caching - -### Two-Level Caching Strategy - -``` -Material Properties + Keywords - ↓ - Variant Key (shader ID + keyword hash) - ↓ - Shader Compilation Cache ← IShaderCompiler - ↓ - Pipeline Key (variant + state + pass) - ↓ - PSO Cache ← IPipelineLibrary -``` - -**Why Two Levels?** - -1. **Shader Variants**: Expensive to compile (milliseconds) - - Cached by keyword combination - - Shared across materials with same keywords - -2. **Pipeline State Objects**: Moderately expensive (microseconds) - - Cached by variant + render state + pass - - Allows per-material state overrides without recompilation - -**Cache Implementation:** -- `ConcurrentDictionary` for thread-safe access -- `TryAdd` avoids double-compilation in race conditions -- Keys are readonly structs for zero-allocation lookups - ---- - -## Batching Algorithm - -### Phase 1: Grouping (O(N)) - -```csharp -foreach (draw in drawCalls) { - key = material.GetPipelineKey(pass, globalKeywords); // O(1) - batches[key].Add(draw); // O(1) amortized -} -``` - -### Phase 2: Sorting (O(K log K)) - -Where K = unique PSO count (typically 10-100, not 1000s) - -```csharp -Array.Sort(batches, (a, b) => - a.PipelineKey.GetHashCode().CompareTo(b.PipelineKey.GetHashCode())); -``` - -**Why Sort?** -- Minimizes PSO switches (most expensive state change) -- Modern GPUs have PSO caches (recent PSOs are faster) -- Locality of reference for shader/texture bindings - -**Expected Batch Reduction:** -- 1000 draws → 10-50 batches (95-98% reduction in state changes) -- Depends on material/pass variety in scene - ---- - -## Thread Safety Model - -### Lock-Free Operations - -- Keyword queries (`IsEnabled`) -- Hash computation (`ComputeHash`) -- Pipeline key generation -- Variant cache lookups (`ConcurrentDictionary`) - -### Fine-Grained Locks - -- **GlobalKeywordState**: Single lock for enable/disable -- **Material**: Per-material lock for property updates -- **MaterialPropertyBlock**: Per-instance lock - -**Rationale:** -- Hot path (rendering) is lock-free -- Mutation (setup) uses minimal locks -- No global locks for per-material operations - ---- - -## Pass System Design - -### Why Multi-Pass? - -Modern rendering requires multiple geometry passes: -1. **Depth Prepass**: Early-Z culling, reduce overdraw -2. **Shadow Pass**: Different state (no color write, depth bias) -3. **Forward/Deferred Base**: Main shading -4. **Transparent Pass**: Different blend state - -### Per-Pass Overrides - -```csharp -material.SetPassRenderState("Shadow", shadowState); -// Same material, different PSO per pass -``` - -**Benefits:** -- Single material definition -- Automatic multi-pass support -- Pass-specific optimizations (e.g., simplified shadow shaders) - ---- - -## Keyword System Philosophy - -### Global vs Local - -**Global** (Platform/Quality): -```csharp -// Set once at startup or quality change -GlobalKeywordState.Instance.EnableKeyword(HDR); -GlobalKeywordState.Instance.EnableKeyword(SHADOWS_CASCADE_4); -``` - -**Local** (Material Features): -```csharp -// Per material instance -material.EnableKeyword(ALPHA_TEST); -material.EnableKeyword(NORMAL_MAP); -``` - -**Variant Explosion Management:** -- Global: ~10 active (platform flags) -- Local: ~5 per material (feature toggles) -- Total variants: 2^(G+L) = 2^15 = 32K possible -- Actually compiled: <100 (used combinations) - -**Warmup Strategy:** -```csharp -// Pre-compile common combinations at load time -variants = [ - {}, // Base - {ALPHA_TEST}, // Foliage - {NORMAL_MAP}, // Detailed - {NORMAL_MAP, METALLIC} // PBR -]; -await WarmupVariantsAsync(shader, variants); -``` - ---- - -## Performance Targets - -### Microbenchmarks - -| Operation | Target | Measured | -|-----------|--------|----------| -| Property Set | <100ns | ~0.1ns | -| Keyword Toggle | <10ns | ~0.01ns | -| Pipeline Key Gen | <50ns | ~20ns | -| Batch 1000 draws | <1ms | ~264ms* | - -*Includes mock compilation delays (10ms variant + 5ms PSO) - -### Real-World Expected - -Without compilation (cached): -- Batching 1000 draws: ~50Ξs -- Property updates: millions/frame possible -- Keyword changes: instant (bitwise ops) - ---- - -## Unsafe Code Justification - -### Where & Why - -1. **Fixed Buffers** (`KeywordSet`): - - Embedded arrays without heap allocation - - Required for compact 64-byte struct - - Alternative: `byte[64]` adds indirection - -2. **Pointer Arithmetic** (`Merge`, `SetBit`): - - Direct memory manipulation - - Eliminates bounds checks in hot path - - ~2x faster than safe indexing - -3. **MaterialPropertyBlock** (`CopyTo`): - - Zero-copy transfer to GPU buffers - - `Buffer.MemoryCopy` for bulk data - - Critical for upload performance - -### Safety Measures - -- All unsafe in implementation, safe public API -- Bounds checking in public methods -- No unsafe pointers escape to callers -- All allocations paired with `Dispose` - ---- - -## Extension & Customization Points - -### 1. Custom Property Types - -```csharp -public void SetTexture(string name, Texture2D tex) -{ - var info = GetOrCreateProperty(name, - MaterialPropertyType.Texture2D, sizeof(IntPtr)); - *(IntPtr*)(_data + info.Offset) = tex.NativePtr; -} -``` - -### 2. Custom Batching Logic - -```csharp -public class DepthSortedRenderer : MaterialBatchRenderer -{ - protected override MaterialBatch[] SortBatches( - MaterialBatch[] batches, CameraData camera) - { - return batches.OrderBy(b => - ComputeDepth(b, camera)).ToArray(); - } -} -``` - -### 3. Material Inheritance - -```csharp -public class LayeredMaterial : Material -{ - private Material _baseMaterial; - - public override void Apply(CommandBuffer cmd) - { - _baseMaterial?.Apply(cmd); // Base properties - base.Apply(cmd); // Override properties - } -} -``` - ---- - -## Comparison to Production Engines - -### Unity URP (Scriptable Render Pipeline) - -**Similarities:** -- Keyword-based variants -- SRP Batcher for reducing CPU overhead -- Per-material property blocks - -**Differences:** -- Ghost: More explicit PSO control -- Unity: Material Properties via MaterialPropertyBlock (separate from Material) -- Ghost: Unsafe for ultimate perf, Unity: Managed with Jobs - -### Unreal Engine 5 - -**Similarities:** -- Material instances with parameter overrides -- Static/Dynamic parameters (global/local keywords) -- PSO caching - -**Differences:** -- Unreal: Node-based material editor -- Unreal: C++ implementation (no GC) -- Ghost: Simpler, more focused on runtime perf - -### Godot 4 - -**Similarities:** -- Shader variants -- Material resource system - -**Differences:** -- Godot: GDScript overhead -- Ghost: Lower-level, more control -- Godot: Integrated editor, Ghost: API-only - ---- - -## Future Optimizations - -### 1. GPU-Driven Rendering - -```csharp -// Upload all materials to GPU buffer -Buffer materialsBuffer = UploadMaterialData(materials); - -// Indirect draw with material index -DrawIndexedIndirect(argsBuffer, materialsBuffer); -``` - -### 2. Parallel Compilation - -```csharp -Parallel.ForEach(pendingVariants, variant => { - var compiled = shaderCompiler.Compile(variant); - cache.TryAdd(variant.Key, compiled); -}); -``` - -### 3. Material LOD - -```csharp -material.SetPassRenderState("LOD0", detailedState); -material.SetPassRenderState("LOD1", simplifiedState); -// Auto-select based on distance -``` - -### 4. Texture Streaming - -```csharp -public void SetTexture(string name, StreamingTexture tex) -{ - tex.RequestMipLevel(currentLOD); - // Bindless texture handle -} -``` - ---- - -## Conclusion - -This system demonstrates: -- ✅ Data-oriented design -- ✅ Cache-friendly memory layouts -- ✅ Minimal allocations -- ✅ Thread-safe where needed -- ✅ Extensible architecture - -Perfect for high-performance rendering in modern game engines. diff --git a/Ghost.Shader.Concept/Ghost.Shader.Concept.csproj b/Ghost.Shader.Concept/Ghost.Shader.Concept.csproj deleted file mode 100644 index 598db52..0000000 --- a/Ghost.Shader.Concept/Ghost.Shader.Concept.csproj +++ /dev/null @@ -1,11 +0,0 @@ -ïŧŋ - - - Exe - net10.0 - enable - enable - true - - - diff --git a/Ghost.Shader.Concept/GlobalKeywordState.cs b/Ghost.Shader.Concept/GlobalKeywordState.cs deleted file mode 100644 index 7039432..0000000 --- a/Ghost.Shader.Concept/GlobalKeywordState.cs +++ /dev/null @@ -1,71 +0,0 @@ -namespace Ghost.Shader.Concept; - -/// -/// Global keyword state manager. Singleton pattern for engine-wide keywords. -/// Keywords like platform settings, quality levels, etc. -/// -public sealed class GlobalKeywordState -{ - private static readonly Lazy _instance = new(() => new GlobalKeywordState()); - public static GlobalKeywordState Instance => _instance.Value; - - private KeywordSet _keywords; - private readonly object _lock = new(); - private int _version = 0; - - public int Version => _version; - - private GlobalKeywordState() - { - _keywords = new KeywordSet(); - } - - public void EnableKeyword(ShaderKeyword keyword) - { - if (keyword.Scope != KeywordScope.Global) - throw new ArgumentException("Only global keywords can be set", nameof(keyword)); - - lock (_lock) - { - _keywords.Enable(keyword); - _version++; - } - } - - public void DisableKeyword(ShaderKeyword keyword) - { - if (keyword.Scope != KeywordScope.Global) - throw new ArgumentException("Only global keywords can be set", nameof(keyword)); - - lock (_lock) - { - _keywords.Disable(keyword); - _version++; - } - } - - public bool IsKeywordEnabled(ShaderKeyword keyword) - { - lock (_lock) - { - return _keywords.IsEnabled(keyword); - } - } - - public KeywordSet GetKeywordSet() - { - lock (_lock) - { - return _keywords; // struct copy - } - } - - public void Clear() - { - lock (_lock) - { - _keywords.Clear(); - _version++; - } - } -} diff --git a/Ghost.Shader.Concept/KeywordSet.cs b/Ghost.Shader.Concept/KeywordSet.cs deleted file mode 100644 index 4964d61..0000000 --- a/Ghost.Shader.Concept/KeywordSet.cs +++ /dev/null @@ -1,161 +0,0 @@ -using System.Runtime.InteropServices; -using System.Runtime.CompilerServices; - -namespace Ghost.Shader.Concept; - -/// -/// Compact representation of enabled keywords using bitsets. -/// Supports up to 256 global and 256 local keywords with O(1) operations. -/// -[StructLayout(LayoutKind.Sequential)] -public unsafe struct KeywordSet : IEquatable -{ - private const int GlobalBits = 256; - private const int LocalBits = 256; - private const int GlobalLongs = GlobalBits / 64; - private const int LocalLongs = LocalBits / 64; - - private fixed ulong _globalBits[GlobalLongs]; - private fixed ulong _localBits[LocalLongs]; - - public void Enable(ShaderKeyword keyword) - { - fixed (ulong* global = _globalBits, local = _localBits) - { - if (keyword.Scope == KeywordScope.Global) - SetBit(global, GlobalLongs, keyword.Id); - else - SetBit(local, LocalLongs, keyword.Id); - } - } - - public void Disable(ShaderKeyword keyword) - { - fixed (ulong* global = _globalBits, local = _localBits) - { - if (keyword.Scope == KeywordScope.Global) - ClearBit(global, GlobalLongs, keyword.Id); - else - ClearBit(local, LocalLongs, keyword.Id); - } - } - - public readonly bool IsEnabled(ShaderKeyword keyword) - { - fixed (ulong* global = _globalBits, local = _localBits) - { - if (keyword.Scope == KeywordScope.Global) - return GetBit(global, GlobalLongs, keyword.Id); - else - return GetBit(local, LocalLongs, keyword.Id); - } - } - - public void Clear() - { - fixed (ulong* global = _globalBits, local = _localBits) - { - for (int i = 0; i < GlobalLongs; i++) - global[i] = 0; - for (int i = 0; i < LocalLongs; i++) - local[i] = 0; - } - } - - public void SetGlobal(KeywordSet* other) - { - fixed (ulong* dest = _globalBits) - { - for (int i = 0; i < GlobalLongs; i++) - dest[i] = other->_globalBits[i]; - } - } - - public void SetLocal(KeywordSet* other) - { - fixed (ulong* dest = _localBits) - { - for (int i = 0; i < LocalLongs; i++) - dest[i] = other->_localBits[i]; - } - } - - public static unsafe KeywordSet Merge(KeywordSet* a, KeywordSet* b) - { - KeywordSet result; - KeywordSet* pResult = &result; - - for (int i = 0; i < GlobalLongs; i++) - pResult->_globalBits[i] = a->_globalBits[i] | b->_globalBits[i]; - for (int i = 0; i < LocalLongs; i++) - pResult->_localBits[i] = a->_localBits[i] | b->_localBits[i]; - - return result; - } - - public readonly ulong ComputeHash() - { - ulong hash = 0xcbf29ce484222325; // FNV-1a offset - const ulong prime = 0x100000001b3; - - fixed (ulong* global = _globalBits, local = _localBits) - { - for (int i = 0; i < GlobalLongs; i++) - { - hash ^= global[i]; - hash *= prime; - } - for (int i = 0; i < LocalLongs; i++) - { - hash ^= local[i]; - hash *= prime; - } - } - return hash; - } - - public readonly bool Equals(KeywordSet other) - { - fixed (ulong* thisGlobal = _globalBits, thisLocal = _localBits) - { - for (int i = 0; i < GlobalLongs; i++) - if (thisGlobal[i] != other._globalBits[i]) - return false; - - for (int i = 0; i < LocalLongs; i++) - if (thisLocal[i] != other._localBits[i]) - return false; - } - return true; - } - - public override readonly bool Equals(object? obj) => obj is KeywordSet other && Equals(other); - public override readonly int GetHashCode() => (int)ComputeHash(); - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static void SetBit(ulong* bits, int count, int index) - { - if (index < 0 || index >= count * 64) return; - int longIndex = index / 64; - int bitIndex = index % 64; - bits[longIndex] |= (1UL << bitIndex); - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static void ClearBit(ulong* bits, int count, int index) - { - if (index < 0 || index >= count * 64) return; - int longIndex = index / 64; - int bitIndex = index % 64; - bits[longIndex] &= ~(1UL << bitIndex); - } - - [MethodImpl(MethodImplOptions.AggressiveInlining)] - private static bool GetBit(ulong* bits, int count, int index) - { - if (index < 0 || index >= count * 64) return false; - int longIndex = index / 64; - int bitIndex = index % 64; - return (bits[longIndex] & (1UL << bitIndex)) != 0; - } -} diff --git a/Ghost.Shader.Concept/Material.cs b/Ghost.Shader.Concept/Material.cs deleted file mode 100644 index 0c70984..0000000 --- a/Ghost.Shader.Concept/Material.cs +++ /dev/null @@ -1,229 +0,0 @@ -namespace Ghost.Shader.Concept; - -/// -/// Represents a material instance with properties, keywords, and per-pass overrides. -/// Thread-safe for property updates, optimized for rendering. -/// -public sealed class Material : IDisposable -{ - private readonly ShaderProgram _shaderProgram; - private readonly MaterialPropertyBlock _propertyBlock; - private KeywordSet _localKeywords; - private readonly RenderState[] _passOverrides; - private readonly object _lock = new(); - private bool _isDirty = true; - - public ShaderProgram ShaderProgram => _shaderProgram; - public bool IsDirty => _isDirty; - - public Material(ShaderProgram shaderProgram) - { - _shaderProgram = shaderProgram; - _propertyBlock = new MaterialPropertyBlock(); - _localKeywords = new KeywordSet(); - _passOverrides = new RenderState[shaderProgram.Passes.Length]; - - // Initialize pass overrides with shader defaults - for (int i = 0; i < _passOverrides.Length; i++) - { - _passOverrides[i] = shaderProgram.Passes[i].RenderState; - } - } - - public void Dispose() - { - _propertyBlock?.Dispose(); - } - - #region Property Updates - - public void SetFloat(string name, float value) - { - _propertyBlock.SetFloat(name, value); - MarkDirty(); - } - - public void SetVector2(string name, float x, float y) - { - _propertyBlock.SetVector2(name, x, y); - MarkDirty(); - } - - public void SetVector3(string name, float x, float y, float z) - { - _propertyBlock.SetVector3(name, x, y, z); - MarkDirty(); - } - - public void SetVector4(string name, float x, float y, float z, float w) - { - _propertyBlock.SetVector4(name, x, y, z, w); - MarkDirty(); - } - - public void SetInt(string name, int value) - { - _propertyBlock.SetInt(name, value); - MarkDirty(); - } - - public void SetMatrix4x4(string name, ReadOnlySpan matrix) - { - _propertyBlock.SetMatrix4x4(name, matrix); - MarkDirty(); - } - - public bool TryGetFloat(string name, out float value) - { - return _propertyBlock.TryGetFloat(name, out value); - } - - #endregion - - #region Keyword Management - - public void EnableKeyword(ShaderKeyword keyword) - { - if (keyword.Scope != KeywordScope.Local) - throw new ArgumentException("Only local keywords can be set on materials", nameof(keyword)); - - lock (_lock) - { - _localKeywords.Enable(keyword); - MarkDirty(); - } - } - - public void DisableKeyword(ShaderKeyword keyword) - { - if (keyword.Scope != KeywordScope.Local) - throw new ArgumentException("Only local keywords can be set on materials", nameof(keyword)); - - lock (_lock) - { - _localKeywords.Disable(keyword); - MarkDirty(); - } - } - - public bool IsKeywordEnabled(ShaderKeyword keyword) - { - lock (_lock) - { - return _localKeywords.IsEnabled(keyword); - } - } - - public KeywordSet GetLocalKeywords() - { - lock (_lock) - { - return _localKeywords; - } - } - - #endregion - - #region Pass State Overrides - - public void SetPassRenderState(int passIndex, RenderState state) - { - if (passIndex < 0 || passIndex >= _passOverrides.Length) - throw new ArgumentOutOfRangeException(nameof(passIndex)); - - lock (_lock) - { - _passOverrides[passIndex] = state; - MarkDirty(); - } - } - - public void SetPassRenderState(string passName, RenderState state) - { - int index = _shaderProgram.GetPassIndex(passName); - if (index < 0) - throw new ArgumentException($"Pass '{passName}' not found in shader program", nameof(passName)); - - SetPassRenderState(index, state); - } - - public RenderState GetPassRenderState(int passIndex) - { - if (passIndex < 0 || passIndex >= _passOverrides.Length) - throw new ArgumentOutOfRangeException(nameof(passIndex)); - - lock (_lock) - { - return _passOverrides[passIndex]; - } - } - - #endregion - - #region Pipeline Key Generation - - /// - /// Generates a pipeline key for a specific pass, combining global and local keywords. - /// - public unsafe GraphicsPipelineKey GetPipelineKey(int passIndex, in KeywordSet globalKeywords) - { - if (passIndex < 0 || passIndex >= _passOverrides.Length) - throw new ArgumentOutOfRangeException(nameof(passIndex)); - - KeywordSet combined; - RenderState state; - - lock (_lock) - { - fixed (KeywordSet* pGlobal = &globalKeywords) - fixed (KeywordSet* pLocal = &_localKeywords) - { - combined = KeywordSet.Merge(pGlobal, pLocal); - } - state = _passOverrides[passIndex]; - } - - var variantKey = _shaderProgram.CreateVariantKey(combined); - var pipelineKey = new GraphicsPipelineKey( - variantKey, - state.ComputeHash(), - _shaderProgram.Passes[passIndex].PassId); - - return pipelineKey; - } - - #endregion - - public unsafe void CopyPropertiesTo(byte* destination, int maxSize) - { - _propertyBlock.CopyTo(destination, maxSize); - } - - public void ClearDirty() - { - _isDirty = false; - } - - private void MarkDirty() - { - _isDirty = true; - } - - public Material Clone() - { - var clone = new Material(_shaderProgram); - - lock (_lock) - { - clone._propertyBlock.CopyFrom(_propertyBlock); - clone._localKeywords = _localKeywords; - - for (int i = 0; i < _passOverrides.Length; i++) - { - clone._passOverrides[i] = _passOverrides[i]; - } - } - - return clone; - } -} diff --git a/Ghost.Shader.Concept/MaterialBatchRenderer.cs b/Ghost.Shader.Concept/MaterialBatchRenderer.cs deleted file mode 100644 index 65f49fc..0000000 --- a/Ghost.Shader.Concept/MaterialBatchRenderer.cs +++ /dev/null @@ -1,158 +0,0 @@ -using System.Collections.Concurrent; - -namespace Ghost.Shader.Concept; - -/// -/// High-performance material batch system for rendering. -/// Groups materials by shader variant and pass for efficient draw call submission. -/// Uses lock-free data structures where possible. -/// -public sealed class MaterialBatchRenderer -{ - private readonly IShaderCompiler _shaderCompiler; - private readonly IPipelineLibrary _pipelineLibrary; - private readonly ConcurrentDictionary _compiledVariants = new(); - private readonly ConcurrentDictionary _cachedPipelines = new(); - - public MaterialBatchRenderer(IShaderCompiler shaderCompiler, IPipelineLibrary pipelineLibrary) - { - _shaderCompiler = shaderCompiler; - _pipelineLibrary = pipelineLibrary; - } - - /// - /// Batches draw calls by material and pass. - /// Returns sorted batches ready for submission. - /// - public MaterialBatch[] BatchDrawCalls(ReadOnlySpan drawCalls) - { - var globalKeywords = GlobalKeywordState.Instance.GetKeywordSet(); - var batchMap = new Dictionary>(); - - // Group by pipeline key - foreach (var drawCall in drawCalls) - { - var material = drawCall.Material; - var passIndex = drawCall.PassIndex; - - var pipelineKey = material.GetPipelineKey(passIndex, globalKeywords); - - if (!batchMap.TryGetValue(pipelineKey, out var batch)) - { - batch = new List(); - batchMap[pipelineKey] = batch; - } - - batch.Add(drawCall); - } - - // Convert to array and ensure PSOs are ready - var batches = new MaterialBatch[batchMap.Count]; - int index = 0; - - foreach (var kvp in batchMap) - { - var pipelineKey = kvp.Key; - var drawCommands = kvp.Value; - - // Ensure shader variant is compiled - EnsureVariantCompiled(pipelineKey.VariantKey, drawCommands[0].Material); - - // Get or create PSO - var pso = GetOrCreatePipeline(pipelineKey); - - batches[index++] = new MaterialBatch - { - PipelineKey = pipelineKey, - Pipeline = pso, - DrawCommands = drawCommands.ToArray() - }; - } - - // Sort batches for optimal state changes (PSO switches are expensive) - Array.Sort(batches, (a, b) => a.PipelineKey.GetHashCode().CompareTo(b.PipelineKey.GetHashCode())); - - return batches; - } - - private unsafe void EnsureVariantCompiled(ShaderVariantKey variantKey, Material material) - { - if (_compiledVariants.ContainsKey(variantKey)) - return; - - var global = GlobalKeywordState.Instance.GetKeywordSet(); - var local = material.GetLocalKeywords(); - KeywordSet keywords = KeywordSet.Merge(&global, &local); - var compiledShader = _shaderCompiler.CompileVariant(variantKey, keywords); - _compiledVariants.TryAdd(variantKey, compiledShader); - } - - private IntPtr GetOrCreatePipeline(GraphicsPipelineKey pipelineKey) - { - if (_cachedPipelines.TryGetValue(pipelineKey, out var cached)) - return cached; - - var pso = _pipelineLibrary.GetOrCreatePipeline(pipelineKey); - _cachedPipelines.TryAdd(pipelineKey, pso); - return pso; - } - - /// - /// Clears compiled shader and pipeline caches. - /// Call when shaders are reloaded or modified. - /// - public void ClearCache() - { - _compiledVariants.Clear(); - _cachedPipelines.Clear(); - } - - /// - /// Pre-warms the cache by compiling common variants. - /// Can be called asynchronously during loading. - /// - public async Task WarmupVariantsAsync(ShaderProgram shader, KeywordSet[] variantConfigurations) - { - var tasks = new List(); - - foreach (var keywords in variantConfigurations) - { - var variantKey = shader.CreateVariantKey(keywords); - - if (!_compiledVariants.ContainsKey(variantKey)) - { - tasks.Add(Task.Run(() => - { - var compiled = _shaderCompiler.CompileVariant(variantKey, keywords); - _compiledVariants.TryAdd(variantKey, compiled); - })); - } - } - - await Task.WhenAll(tasks); - } -} - -/// -/// Represents a single draw command with material and instance data. -/// -public struct DrawCommand -{ - public Material Material; - public int PassIndex; - public IntPtr VertexBuffer; - public IntPtr IndexBuffer; - public int IndexCount; - public int InstanceCount; - public IntPtr InstanceData; -} - -/// -/// A batch of draw commands sharing the same PSO. -/// -public struct MaterialBatch -{ - public GraphicsPipelineKey PipelineKey; - public IntPtr Pipeline; - public DrawCommand[] DrawCommands; -} diff --git a/Ghost.Shader.Concept/MaterialPool.cs b/Ghost.Shader.Concept/MaterialPool.cs deleted file mode 100644 index 09f364a..0000000 --- a/Ghost.Shader.Concept/MaterialPool.cs +++ /dev/null @@ -1,58 +0,0 @@ -namespace Ghost.Shader.Concept; - -/// -/// Material instance pool for efficient reuse and memory management. -/// Reduces GC pressure for frequently created/destroyed materials. -/// -public sealed class MaterialPool -{ - private readonly Dictionary> _pools = new(); - private readonly object _lock = new(); - - public Material Rent(ShaderProgram shaderProgram) - { - lock (_lock) - { - if (_pools.TryGetValue(shaderProgram, out var pool) && pool.Count > 0) - { - var material = pool.Pop(); - return material; - } - } - - return new Material(shaderProgram); - } - - public void Return(Material material) - { - if (material == null) - return; - - lock (_lock) - { - if (!_pools.TryGetValue(material.ShaderProgram, out var pool)) - { - pool = new Stack(); - _pools[material.ShaderProgram] = pool; - } - - pool.Push(material); - } - } - - public void Clear() - { - lock (_lock) - { - foreach (var pool in _pools.Values) - { - while (pool.Count > 0) - { - var material = pool.Pop(); - material.Dispose(); - } - } - _pools.Clear(); - } - } -} diff --git a/Ghost.Shader.Concept/MaterialPropertyBlock.cs b/Ghost.Shader.Concept/MaterialPropertyBlock.cs deleted file mode 100644 index 92394ea..0000000 --- a/Ghost.Shader.Concept/MaterialPropertyBlock.cs +++ /dev/null @@ -1,224 +0,0 @@ -using System.Runtime.InteropServices; - -namespace Ghost.Shader.Concept; - -/// -/// Material property types supported by the system. -/// -public enum MaterialPropertyType : byte -{ - Float, - Float2, - Float3, - Float4, - Int, - Matrix4x4, - Texture2D, - TextureCube -} - -/// -/// Metadata for a material property. -/// -public readonly struct MaterialPropertyInfo -{ - public readonly string Name; - public readonly MaterialPropertyType Type; - public readonly int Offset; - public readonly int Size; - - public MaterialPropertyInfo(string name, MaterialPropertyType type, int offset, int size) - { - Name = name; - Type = type; - Offset = offset; - Size = size; - } -} - -/// -/// Thread-safe storage for material properties using linear memory layout. -/// Optimized for fast updates and GPU buffer uploads. -/// -public unsafe sealed class MaterialPropertyBlock : IDisposable -{ - private byte* _data; - private int _capacity; - private int _size; - private readonly object _lock = new(); - private readonly Dictionary _properties = new(); - - public int Size => _size; - public IntPtr DataPtr => (IntPtr)_data; - - public MaterialPropertyBlock(int initialCapacity = 1024) - { - _capacity = initialCapacity; - _data = (byte*)Marshal.AllocHGlobal(_capacity); - _size = 0; - } - - ~MaterialPropertyBlock() - { - Dispose(false); - } - - public void Dispose() - { - Dispose(true); - GC.SuppressFinalize(this); - } - - private void Dispose(bool disposing) - { - if (_data != null) - { - Marshal.FreeHGlobal((IntPtr)_data); - _data = null; - } - } - - private void EnsureCapacity(int required) - { - if (_capacity >= required) return; - - int newCapacity = Math.Max(_capacity * 2, required); - byte* newData = (byte*)Marshal.AllocHGlobal(newCapacity); - Buffer.MemoryCopy(_data, newData, newCapacity, _size); - Marshal.FreeHGlobal((IntPtr)_data); - _data = newData; - _capacity = newCapacity; - } - - public void SetFloat(string name, float value) - { - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Float, sizeof(float)); - *(float*)(_data + info.Offset) = value; - } - } - - public void SetVector2(string name, float x, float y) - { - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Float2, sizeof(float) * 2); - float* ptr = (float*)(_data + info.Offset); - ptr[0] = x; - ptr[1] = y; - } - } - - public void SetVector3(string name, float x, float y, float z) - { - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Float3, sizeof(float) * 3); - float* ptr = (float*)(_data + info.Offset); - ptr[0] = x; - ptr[1] = y; - ptr[2] = z; - } - } - - public void SetVector4(string name, float x, float y, float z, float w) - { - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Float4, sizeof(float) * 4); - float* ptr = (float*)(_data + info.Offset); - ptr[0] = x; - ptr[1] = y; - ptr[2] = z; - ptr[3] = w; - } - } - - public void SetInt(string name, int value) - { - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Int, sizeof(int)); - *(int*)(_data + info.Offset) = value; - } - } - - public void SetMatrix4x4(string name, ReadOnlySpan matrix) - { - if (matrix.Length != 16) - throw new ArgumentException("Matrix must have 16 elements", nameof(matrix)); - - lock (_lock) - { - var info = GetOrCreateProperty(name, MaterialPropertyType.Matrix4x4, sizeof(float) * 16); - fixed (float* src = matrix) - { - Buffer.MemoryCopy(src, _data + info.Offset, info.Size, info.Size); - } - } - } - - public bool TryGetFloat(string name, out float value) - { - lock (_lock) - { - if (_properties.TryGetValue(name, out var info) && info.Type == MaterialPropertyType.Float) - { - value = *(float*)(_data + info.Offset); - return true; - } - value = 0; - return false; - } - } - - public void CopyTo(byte* destination, int maxSize) - { - lock (_lock) - { - int copySize = Math.Min(_size, maxSize); - Buffer.MemoryCopy(_data, destination, maxSize, copySize); - } - } - - public void CopyFrom(MaterialPropertyBlock source) - { - lock (_lock) - { - lock (source._lock) - { - EnsureCapacity(source._size); - Buffer.MemoryCopy(source._data, _data, _capacity, source._size); - _size = source._size; - _properties.Clear(); - foreach (var kvp in source._properties) - { - _properties[kvp.Key] = kvp.Value; - } - } - } - } - - private MaterialPropertyInfo GetOrCreateProperty(string name, MaterialPropertyType type, int size) - { - if (_properties.TryGetValue(name, out var existing)) - { - if (existing.Type != type) - throw new InvalidOperationException($"Property {name} type mismatch: expected {existing.Type}, got {type}"); - return existing; - } - - // Align to 16 bytes for GPU compatibility - int offset = (_size + 15) & ~15; - int alignedSize = (size + 15) & ~15; - - EnsureCapacity(offset + alignedSize); - - var info = new MaterialPropertyInfo(name, type, offset, alignedSize); - _properties[name] = info; - _size = offset + alignedSize; - - return info; - } -} diff --git a/Ghost.Shader.Concept/PROJECT_SUMMARY.md b/Ghost.Shader.Concept/PROJECT_SUMMARY.md deleted file mode 100644 index c3b8154..0000000 --- a/Ghost.Shader.Concept/PROJECT_SUMMARY.md +++ /dev/null @@ -1,276 +0,0 @@ -# Ghost Shader Concept - Project Summary - -## ðŸŽŊ Project Goal - -Build a high-performance material and shader system with: -- ✅ Material property updates -- ✅ Shader variants via keywords (global + local) -- ✅ Multi-pass rendering support -- ✅ Per-pass pipeline state overrides -- ✅ Modern, cache-friendly architecture -- ✅ Thread-safe operations -- ✅ Unsafe code for maximum performance - -## ðŸ“Ķ Delivered Components - -### Core System Files - -1. **ShaderKeyword.cs** - Keyword definition and registration - - Global vs Local scopes - - Interned keyword IDs - - Thread-safe registry - -2. **KeywordSet.cs** - Compact keyword storage (64 bytes) - - Bitset-based (256 global + 256 local) - - O(1) operations - - Fast hashing and merging - -3. **ShaderKeys.cs** - PSO and variant key structures - - `ShaderVariantKey`: Shader + keywords - - `GraphicsPipelineKey`: Variant + state + pass - - Mock interfaces for compiler/library - -4. **RenderState.cs** - Pipeline state definition - - Rasterizer, depth-stencil, blend states - - Immutable, hashable - - Enums for all state values - -5. **ShaderProgram.cs** - Multi-pass shader definition - - `ShaderPass`: Name, state, entry points - - `ShaderProgram`: Collection of passes - - Builder pattern for construction - -6. **MaterialPropertyBlock.cs** - Property storage - - Dynamic, 16-byte aligned layout - - Thread-safe updates - - Direct GPU upload support - - Supports: float, float2/3/4, int, matrix4x4 - -7. **Material.cs** - Material instance - - Properties + keywords + pass overrides - - Thread-safe mutations - - Dirty tracking - - Cloning support - -8. **GlobalKeywordState.cs** - Engine-wide keyword manager - - Singleton pattern - - Version tracking - - Merges with local keywords at render time - -9. **MaterialBatchRenderer.cs** - High-performance batching - - Groups draws by PSO - - Automatic variant compilation - - PSO caching - - Async variant warmup - -10. **MaterialPool.cs** - Object pooling - - Reduces allocations - - Per-shader-program pools - -### Documentation - -- **README.md** - User guide and API documentation -- **ARCHITECTURE.md** - Technical deep dive -- **Program.cs** - Comprehensive demo showing all features - -## 🚀 Key Features - -### Performance Optimizations - -1. **Data-Oriented Design** - - Compact structs (KeywordSet = 64 bytes) - - Cache-line friendly layouts - - Minimal pointer chasing - -2. **Lock-Free Hot Paths** - - Keyword queries - - Hash computation - - Pipeline key generation - - Variant cache lookups - -3. **Batching System** - - Reduces 1000 draws → ~10-50 batches - - Minimizes expensive PSO switches - - Sort by PSO hash for cache locality - -4. **Memory Efficiency** - - Stack-allocated keys - - Pooled materials - - Aligned property blocks (GPU-friendly) - -### Multi-Pass Architecture - -```csharp -var shader = new ShaderProgramBuilder() - .WithName("PBR") - .AddPass("ForwardBase", baseState) - .AddPass("ShadowCaster", shadowState) - .AddPass("DepthPrepass", depthState) - .Build(); -``` - -Each pass can have: -- Custom render state -- Separate entry points -- Individual PSOs - -### Keyword Variants - -```csharp -// Global (platform/quality) -GlobalKeywordState.Instance.EnableKeyword(HDR); -GlobalKeywordState.Instance.EnableKeyword(SHADOWS); - -// Local (per-material) -material.EnableKeyword(ALPHA_TEST); -material.EnableKeyword(NORMAL_MAP); - -// Automatically merged at render time -var psoKey = material.GetPipelineKey(passIndex, globalKeywords); -``` - -### Per-Pass State Overrides - -```csharp -var transparentState = RenderState.Default; -transparentState.BlendEnable = true; -transparentState.SrcBlend = BlendFactor.SrcAlpha; -transparentState.DestBlend = BlendFactor.InvSrcAlpha; - -material.SetPassRenderState("ForwardBase", transparentState); -// Shadow pass still uses opaque state -``` - -## 📊 Performance Results - -From demo run (with mock compilation delays): - -| Metric | Value | -|--------|-------| -| Property Updates | 10,000 updates/ms | -| Keyword Toggles | Instant (<1ms for 10K) | -| Batching Efficiency | 1000 draws → 12 batches | -| Variant Warmup | 8 variants in 25ms | -| Material Cloning | 1000 cycles in 0ms | - -Real-world (cached, no compilation): -- Batching: ~50Ξs for 1000 draws -- Property updates: Millions per frame -- Zero GC allocations in render loop - -## ðŸŽĻ Usage Example - -```csharp -// 1. Define keywords -var alphaTest = ShaderKeywordRegistry.Instance - .GetOrRegister("ALPHA_TEST", KeywordScope.Local); - -// 2. Create shader program -var shader = new ShaderProgramBuilder() - .WithName("Standard") - .AddPass("Forward", RenderState.Default) - .DeclareKeywords(alphaTest) - .Build(); - -// 3. Create material -var material = new Material(shader); -material.SetVector4("_Color", 1, 0, 0, 1); -material.SetFloat("_Metallic", 0.8f); -material.EnableKeyword(alphaTest); - -// 4. Batch and render -var batches = batchRenderer.BatchDrawCalls(drawCommands); -foreach (var batch in batches) { - SetPipeline(batch.Pipeline); - foreach (var draw in batch.DrawCommands) { - draw.Material.CopyPropertiesTo(cbufferPtr, size); - DrawIndexed(...); - } -} -``` - -## 🔧 Technical Highlights - -### Unsafe Code Usage - -- **KeywordSet**: Fixed buffers for embedded arrays -- **Merge operations**: Pointer arithmetic for speed -- **Property upload**: Zero-copy GPU transfer - -### Thread Safety - -- **Lock-free reads**: All queries and hash ops -- **Fine-grained locks**: Per-material, per-block -- **Concurrent caches**: `ConcurrentDictionary` for variants/PSOs - -### Extensibility - -- Custom property types -- Custom batching strategies -- Material inheritance -- Pass/variant warmup strategies - -## 🌟 Inspirations - -Combines best practices from: - -- **Unity DOTS**: Data-oriented design, SRP batching -- **Unreal Engine 5**: Material instances, PSO caching -- **Godot 4**: Clean API, variant system -- **Modern D3D12/Vulkan**: Explicit PSO control - -## 📁 Files Created - -``` -Ghost.Shader.Concept/ -├── ShaderKeyword.cs (70 lines) -├── KeywordSet.cs (165 lines) -├── ShaderKeys.cs (60 lines) -├── RenderState.cs (135 lines) -├── ShaderProgram.cs (110 lines) -├── MaterialPropertyBlock.cs (190 lines) -├── Material.cs (205 lines) -├── GlobalKeywordState.cs (65 lines) -├── MaterialBatchRenderer.cs (145 lines) -├── MaterialPool.cs (55 lines) -├── Program.cs (260 lines) -├── README.md (485 lines) -└── ARCHITECTURE.md (430 lines) - -Total: ~2,400 lines of implementation + documentation -``` - -## âœĻ What Makes This Different - -Unlike your existing codebase, this system emphasizes: - -1. **Explicit PSO management** - Full control over pipeline states -2. **Bitset keywords** - More compact than typical implementations -3. **Static merge** - Compile-time variant selection -4. **Pointer-based merge** - Unusual in C#, max performance -5. **Per-pass overrides** - Rare feature in material systems -6. **Zero-allocation rendering** - Structs and pooling throughout - -## 🎓 Learning Points - -This implementation demonstrates: - -- Advanced unsafe C# patterns -- Lock-free concurrent programming -- Cache-friendly data structures -- Graphics API abstraction -- Performance-critical system design -- Modern rendering architecture - -## 🚧 Future Enhancements - -- GPU-driven rendering -- Bindless textures -- Material graphs -- Hot reload support -- Compute shader integration -- Material LOD system - ---- - -**Status**: ✅ Fully functional, builds successfully, demo runs perfectly! diff --git a/Ghost.Shader.Concept/Program.cs b/Ghost.Shader.Concept/Program.cs deleted file mode 100644 index b71e805..0000000 --- a/Ghost.Shader.Concept/Program.cs +++ /dev/null @@ -1,258 +0,0 @@ -using System.Diagnostics; - -namespace Ghost.Shader.Concept; - -/// -/// Mock implementations for demonstration -/// -internal class MockShaderCompiler : IShaderCompiler -{ - public IntPtr CompileVariant(ShaderVariantKey key, in KeywordSet keywords) - { - // Simulate compilation delay - Thread.Sleep(10); - return new IntPtr(key.GetHashCode()); - } -} - -internal class MockPipelineLibrary : IPipelineLibrary -{ - public IntPtr GetOrCreatePipeline(in GraphicsPipelineKey key) - { - // Simulate PSO creation - Thread.Sleep(5); - return new IntPtr(key.GetHashCode()); - } -} - -class Program -{ - static void Main(string[] args) - { - Console.WriteLine("=== Ghost Shader Concept - High Performance Material System ===\n"); - - // Initialize system - var registry = ShaderKeywordRegistry.Instance; - var compiler = new MockShaderCompiler(); - var pipelineLib = new MockPipelineLibrary(); - var batchRenderer = new MaterialBatchRenderer(compiler, pipelineLib); - var materialPool = new MaterialPool(); - - Console.WriteLine("1. Creating Keywords..."); - var globalHDR = registry.GetOrRegister("HDR", KeywordScope.Global); - var globalShadows = registry.GetOrRegister("SHADOWS_ENABLED", KeywordScope.Global); - var localAlphaTest = registry.GetOrRegister("ALPHA_TEST", KeywordScope.Local); - var localNormalMap = registry.GetOrRegister("NORMAL_MAP", KeywordScope.Local); - var localMetallic = registry.GetOrRegister("METALLIC_WORKFLOW", KeywordScope.Local); - - // Set global keywords - GlobalKeywordState.Instance.EnableKeyword(globalHDR); - GlobalKeywordState.Instance.EnableKeyword(globalShadows); - Console.WriteLine($" - Global Keywords: HDR, SHADOWS_ENABLED"); - Console.WriteLine($" - Local Keywords: ALPHA_TEST, NORMAL_MAP, METALLIC_WORKFLOW\n"); - - // Create shader program with multiple passes - Console.WriteLine("2. Creating Shader Program with Multi-Pass..."); - var shaderProgram = new ShaderProgramBuilder() - .WithName("StandardPBR") - .AddPass("ForwardBase", RenderState.Default) - .AddPass("ShadowCaster", new RenderState - { - CullMode = CullMode.Back, - FillMode = FillMode.Solid, - DepthTestEnable = true, - DepthWriteEnable = true, - DepthCompareFunc = CompareFunction.LessEqual, - ColorWriteMask = ColorWriteMask.None, - Topology = PrimitiveTopology.TriangleList - }) - .AddPass("DepthPrepass", new RenderState - { - CullMode = CullMode.Back, - DepthTestEnable = true, - DepthWriteEnable = true, - ColorWriteMask = ColorWriteMask.None, - Topology = PrimitiveTopology.TriangleList - }) - .DeclareKeywords(localAlphaTest, localNormalMap, localMetallic) - .Build(); - - Console.WriteLine($" - Shader: {shaderProgram.Name} (ID: {shaderProgram.Id})"); - Console.WriteLine($" - Passes: {shaderProgram.Passes.Length}"); - foreach (var pass in shaderProgram.Passes) - { - Console.WriteLine($" * {pass.Name} (ID: {pass.PassId})"); - } - Console.WriteLine(); - - // Create materials with different configurations - Console.WriteLine("3. Creating Material Instances..."); - var materials = new List(); - - // Material 1: Basic opaque - var mat1 = new Material(shaderProgram); - mat1.SetVector4("_Color", 1.0f, 0.0f, 0.0f, 1.0f); - mat1.SetFloat("_Metallic", 0.5f); - mat1.SetFloat("_Roughness", 0.3f); - mat1.EnableKeyword(localMetallic); - materials.Add(mat1); - Console.WriteLine($" - Material 1: Red Metallic (Keywords: METALLIC_WORKFLOW)"); - - // Material 2: Alpha tested - var mat2 = new Material(shaderProgram); - mat2.SetVector4("_Color", 0.0f, 1.0f, 0.0f, 0.5f); - mat2.SetFloat("_Cutoff", 0.5f); - mat2.EnableKeyword(localAlphaTest); - materials.Add(mat2); - Console.WriteLine($" - Material 2: Green Alpha Test (Keywords: ALPHA_TEST)"); - - // Material 3: Full featured - var mat3 = new Material(shaderProgram); - mat3.SetVector4("_Color", 0.0f, 0.0f, 1.0f, 1.0f); - mat3.SetFloat("_Metallic", 1.0f); - mat3.SetFloat("_Roughness", 0.1f); - mat3.EnableKeyword(localMetallic); - mat3.EnableKeyword(localNormalMap); - materials.Add(mat3); - Console.WriteLine($" - Material 3: Blue Metallic + Normal Map (Keywords: METALLIC_WORKFLOW, NORMAL_MAP)"); - - // Material 4: Override blend state for transparent pass - var mat4 = new Material(shaderProgram); - mat4.SetVector4("_Color", 1.0f, 1.0f, 0.0f, 0.7f); - var transparentState = RenderState.Default; - transparentState.BlendEnable = true; - transparentState.SrcBlend = BlendFactor.SrcAlpha; - transparentState.DestBlend = BlendFactor.InvSrcAlpha; - mat4.SetPassRenderState(0, transparentState); - materials.Add(mat4); - Console.WriteLine($" - Material 4: Yellow Transparent (Per-pass blend override)\n"); - - // Demonstrate material property updates - Console.WriteLine("4. Testing Material Property Updates..."); - var sw = Stopwatch.StartNew(); - for (int i = 0; i < 10000; i++) - { - mat1.SetFloat("_Metallic", (float)Math.Sin(i * 0.01)); - mat1.SetVector4("_Color", 1.0f, 0.5f, 0.5f, 1.0f); - } - sw.Stop(); - Console.WriteLine($" - 10,000 property updates: {sw.ElapsedMilliseconds}ms ({10000.0 / sw.ElapsedMilliseconds:F2} updates/ms)\n"); - - // Demonstrate keyword toggling - Console.WriteLine("5. Testing Keyword Toggle Performance..."); - sw.Restart(); - for (int i = 0; i < 10000; i++) - { - if (i % 2 == 0) - mat3.EnableKeyword(localAlphaTest); - else - mat3.DisableKeyword(localAlphaTest); - } - sw.Stop(); - Console.WriteLine($" - 10,000 keyword toggles: {sw.ElapsedMilliseconds}ms ({10000.0 / sw.ElapsedMilliseconds:F2} toggles/ms)\n"); - - // Create draw commands - Console.WriteLine("6. Creating Draw Commands..."); - var drawCommands = new List(); - var random = new Random(42); - - for (int i = 0; i < 1000; i++) - { - drawCommands.Add(new DrawCommand - { - Material = materials[random.Next(materials.Count)], - PassIndex = random.Next(3), // Random pass - VertexBuffer = new IntPtr(i * 1000), - IndexBuffer = new IntPtr(i * 1000 + 500), - IndexCount = 36, - InstanceCount = 1, - InstanceData = IntPtr.Zero - }); - } - Console.WriteLine($" - Created {drawCommands.Count} draw commands\n"); - - // Batch rendering - Console.WriteLine("7. Batching Draw Calls..."); - sw.Restart(); - var batches = batchRenderer.BatchDrawCalls(drawCommands.ToArray()); - sw.Stop(); - Console.WriteLine($" - Batched into {batches.Length} unique PSO states"); - Console.WriteLine($" - Batching time: {sw.ElapsedMilliseconds}ms"); - Console.WriteLine($" - Average batch size: {drawCommands.Count / (float)batches.Length:F2} draws/batch\n"); - - // Show batch details - Console.WriteLine("8. Batch Details:"); - int batchNum = 1; - foreach (var batch in batches.Take(5)) - { - Console.WriteLine($" Batch {batchNum++}:"); - Console.WriteLine($" - PSO Hash: 0x{batch.PipelineKey.GetHashCode():X8}"); - Console.WriteLine($" - Draw calls: {batch.DrawCommands.Length}"); - Console.WriteLine($" - Shader variant: 0x{batch.PipelineKey.VariantKey.KeywordHash:X16}"); - } - if (batches.Length > 5) - Console.WriteLine($" ... and {batches.Length - 5} more batches\n"); - - // Demonstrate variant warmup - Console.WriteLine("9. Shader Variant Warmup (Async)..."); - var warmupConfigs = new KeywordSet[8]; - for (int i = 0; i < warmupConfigs.Length; i++) - { - warmupConfigs[i] = new KeywordSet(); - if ((i & 1) != 0) warmupConfigs[i].Enable(localAlphaTest); - if ((i & 2) != 0) warmupConfigs[i].Enable(localNormalMap); - if ((i & 4) != 0) warmupConfigs[i].Enable(localMetallic); - } - - sw.Restart(); - var warmupTask = batchRenderer.WarmupVariantsAsync(shaderProgram, warmupConfigs); - warmupTask.Wait(); - sw.Stop(); - Console.WriteLine($" - Pre-compiled {warmupConfigs.Length} variants in {sw.ElapsedMilliseconds}ms\n"); - - // Material cloning - Console.WriteLine("10. Material Cloning..."); - var clonedMat = mat3.Clone(); - Console.WriteLine($" - Cloned material 3"); - Console.WriteLine($" - Original metallic: {(mat3.TryGetFloat("_Metallic", out var m1) ? m1 : 0)}"); - Console.WriteLine($" - Clone metallic: {(clonedMat.TryGetFloat("_Metallic", out var m2) ? m2 : 0)}"); - clonedMat.SetFloat("_Metallic", 0.0f); - Console.WriteLine($" - After clone modification:"); - Console.WriteLine($" Original: {(mat3.TryGetFloat("_Metallic", out var m3) ? m3 : 0)}"); - Console.WriteLine($" Clone: {(clonedMat.TryGetFloat("_Metallic", out var m4) ? m4 : 0)}\n"); - - // Material pooling - Console.WriteLine("11. Material Pooling..."); - sw.Restart(); - for (int i = 0; i < 1000; i++) - { - var pooledMat = materialPool.Rent(shaderProgram); - pooledMat.SetFloat("_Test", i); - materialPool.Return(pooledMat); - } - sw.Stop(); - Console.WriteLine($" - 1000 rent/return cycles: {sw.ElapsedMilliseconds}ms\n"); - - // Cleanup - Console.WriteLine("12. Cleanup..."); - foreach (var mat in materials) - { - mat.Dispose(); - } - clonedMat.Dispose(); - materialPool.Clear(); - Console.WriteLine(" - All materials disposed\n"); - - Console.WriteLine("=== Demo Complete ==="); - Console.WriteLine("\nKey Features Demonstrated:"); - Console.WriteLine(" ✓ Multi-pass shader support"); - Console.WriteLine(" ✓ Global and local keyword system"); - Console.WriteLine(" ✓ Shader variant compilation"); - Console.WriteLine(" ✓ Per-pass pipeline state overrides"); - Console.WriteLine(" ✓ Fast material property updates"); - Console.WriteLine(" ✓ Efficient draw call batching"); - Console.WriteLine(" ✓ Async variant warmup"); - Console.WriteLine(" ✓ Material cloning and pooling"); - Console.WriteLine(" ✓ Cache-friendly data structures"); - } -} diff --git a/Ghost.Shader.Concept/README.md b/Ghost.Shader.Concept/README.md deleted file mode 100644 index 9d09932..0000000 --- a/Ghost.Shader.Concept/README.md +++ /dev/null @@ -1,356 +0,0 @@ -# Ghost Shader Concept - High Performance Material System - -A modern, high-performance material and shader system designed for maximum efficiency and flexibility. Built with data-oriented design principles inspired by Unity DOTS, Unreal Engine 5, and modern rendering engines. - -## Architecture Overview - -### Core Design Principles - -1. **Data-Oriented Design**: Cache-friendly memory layouts for optimal performance -2. **Lock-Free Where Possible**: Concurrent collections and atomic operations minimize contention -3. **Zero-Allocation Hot Paths**: Struct-based keys and value types reduce GC pressure -4. **Compile-Time Variants**: Shader permutations compiled ahead or on-demand -5. **Batch-Friendly**: Automatic PSO batching for minimal state changes - ---- - -## System Components - -### 1. Keyword System (`ShaderKeyword.cs`, `KeywordSet.cs`) - -**Keywords** enable/disable shader features at compile time, creating variants. - -- **Global Keywords**: Engine-wide settings (HDR, shadow quality, platform features) -- **Local Keywords**: Per-material settings (normal mapping, alpha test, etc.) - -**KeywordSet**: Compact bitset (256 global + 256 local keywords) using unsafe fixed buffers -- O(1) enable/disable/query operations -- Fast hash computation for variant key generation -- Supports merging global + local keywords - -```csharp -var keywords = new KeywordSet(); -keywords.Enable(alphaTestKeyword); -keywords.Enable(normalMapKeyword); -ulong hash = keywords.ComputeHash(); // For variant lookup -``` - -### 2. Shader Variant System (`ShaderKeys.cs`) - -**ShaderVariantKey**: Uniquely identifies a compiled shader variant -- Combines shader program ID + keyword hash -- Used as cache key for `IShaderCompiler` - -**GraphicsPipelineKey**: Uniquely identifies a complete PSO -- Combines shader variant + render state hash + pass ID -- Used as cache key for `IPipelineLibrary` - -### 3. Render State (`RenderState.cs`) - -Immutable, hashable pipeline state: -- Rasterizer (cull mode, fill mode, depth bias) -- Depth-Stencil (test/write enable, compare func, stencil ops) -- Blend State (per-RT blend factors and operations) -- Topology - -```csharp -var state = RenderState.Default; -state.BlendEnable = true; -state.SrcBlend = BlendFactor.SrcAlpha; -ulong hash = state.ComputeHash(); -``` - -### 4. Shader Programs (`ShaderProgram.cs`) - -A **ShaderProgram** represents a complete shader with multiple passes. - -**ShaderPass**: Single rendering pass with: -- Name and ID -- Default render state -- Entry point functions (vertex/pixel) - -**Builder Pattern** for clean creation: - -```csharp -var shader = new ShaderProgramBuilder() - .WithName("StandardPBR") - .AddPass("ForwardBase", RenderState.Default) - .AddPass("ShadowCaster", shadowState) - .DeclareKeywords(alphaTest, normalMap) - .Build(); -``` - -### 5. Material Properties (`MaterialPropertyBlock.cs`) - -**Thread-safe**, **linear memory layout** for GPU upload efficiency. - -Supports: -- Scalars (float, int) -- Vectors (float2, float3, float4) -- Matrices (4x4) -- Textures (planned) - -Properties are **16-byte aligned** for GPU compatibility and stored contiguously. - -```csharp -var props = new MaterialPropertyBlock(); -props.SetFloat("_Metallic", 0.5f); -props.SetVector4("_Color", 1, 0, 0, 1); -unsafe { - props.CopyTo(gpuBufferPtr, bufferSize); -} -``` - -### 6. Materials (`Material.cs`) - -High-level material instance combining: -- **Shader program** reference -- **Property block** for per-material data -- **Local keywords** for variant selection -- **Per-pass render state overrides** - -**Thread-safe** for property updates. **Dirty tracking** for efficient GPU updates. - -```csharp -var material = new Material(shaderProgram); -material.SetFloat("_Metallic", 0.8f); -material.EnableKeyword(normalMapKeyword); -material.SetPassRenderState("ForwardBase", transparentState); - -// Get pipeline key for rendering -var psoKey = material.GetPipelineKey(passIndex, globalKeywords); -``` - -**Cloning** for material instances: -```csharp -var clone = material.Clone(); // Deep copy of properties and state -``` - -### 7. Global State (`GlobalKeywordState.cs`) - -Singleton managing **engine-wide keywords**. -- Thread-safe keyword enable/disable -- Version tracking for cache invalidation -- Automatic merging with local keywords during rendering - -```csharp -GlobalKeywordState.Instance.EnableKeyword(hdrKeyword); -var keywords = GlobalKeywordState.Instance.GetKeywordSet(); -``` - -### 8. Batch Renderer (`MaterialBatchRenderer.cs`) - -**Core rendering system** that: -1. Groups draw calls by PSO (shader variant + render state + pass) -2. Ensures shader variants are compiled -3. Gets/creates PSOs from pipeline library -4. Returns sorted batches for minimal state changes - -```csharp -var batches = batchRenderer.BatchDrawCalls(drawCalls); -foreach (var batch in batches) { - SetPipeline(batch.Pipeline); - foreach (var draw in batch.DrawCommands) { - // Upload material properties - // Issue draw call - } -} -``` - -**Async Warmup** for pre-compiling variants: -```csharp -await batchRenderer.WarmupVariantsAsync(shader, variantConfigs); -``` - -### 9. Material Pooling (`MaterialPool.cs`) - -Object pool for material instances to reduce allocations. - -```csharp -var material = pool.Rent(shaderProgram); -// Use material... -pool.Return(material); -``` - ---- - -## Performance Characteristics - -### Memory Layout -- **KeywordSet**: 64 bytes (fixed size, stack-allocated) -- **RenderState**: ~60 bytes (stack-allocated) -- **MaterialPropertyBlock**: Variable, contiguous, 16-byte aligned - -### Complexity -- **Keyword enable/disable**: O(1) -- **Hash computation**: O(1) - fixed iterations -- **Pipeline key generation**: O(1) -- **Batch sorting**: O(N log N) where N = unique PSOs (typically << draw calls) - -### Concurrency -- **Lock-free**: Keyword queries, hash computation, key generation -- **Concurrent**: Variant compilation cache, PSO cache -- **Thread-safe**: Material property updates, global keyword changes - ---- - -## Usage Example - -```csharp -// 1. Setup -var registry = ShaderKeywordRegistry.Instance; -var normalMap = registry.GetOrRegister("NORMAL_MAP", KeywordScope.Local); -var hdr = registry.GetOrRegister("HDR", KeywordScope.Global); - -GlobalKeywordState.Instance.EnableKeyword(hdr); - -// 2. Create shader -var shader = new ShaderProgramBuilder() - .WithName("PBR") - .AddPass("Forward", RenderState.Default) - .AddPass("Shadow", shadowState) - .DeclareKeywords(normalMap) - .Build(); - -// 3. Create material -var material = new Material(shader); -material.SetVector4("_BaseColor", 1, 0, 0, 1); -material.SetFloat("_Metallic", 0.8f); -material.EnableKeyword(normalMap); - -// 4. Render -var batchRenderer = new MaterialBatchRenderer(compiler, pipelineLib); -var batches = batchRenderer.BatchDrawCalls(drawCommands); - -foreach (var batch in batches) { - commandList.SetPipeline(batch.Pipeline); - foreach (var draw in batch.DrawCommands) { - unsafe { - draw.Material.CopyPropertiesTo(cbufferPtr, cbufferSize); - } - commandList.DrawIndexed(draw.IndexCount, ...); - } -} -``` - ---- - -## Advanced Features - -### Per-Pass State Overrides - -Materials can override render state per-pass: - -```csharp -var transparentState = RenderState.Default; -transparentState.BlendEnable = true; -transparentState.SrcBlend = BlendFactor.SrcAlpha; -transparentState.DestBlend = BlendFactor.InvSrcAlpha; - -material.SetPassRenderState("Forward", transparentState); -material.SetPassRenderState("Shadow", RenderState.Default); // Opaque shadow -``` - -### Shader Variant Warmup - -Pre-compile common variants to avoid runtime hitches: - -```csharp -var variants = new[] { - keywordSet1, // No features - keywordSet2, // Normal map only - keywordSet3, // Normal map + alpha test - // ... -}; - -await batchRenderer.WarmupVariantsAsync(shader, variants); -``` - -### Material Property Inheritance - -Clone materials with shared base properties: - -```csharp -var baseMaterial = new Material(shader); -baseMaterial.SetVector4("_BaseColor", 1, 1, 1, 1); - -var redVariant = baseMaterial.Clone(); -redVariant.SetVector4("_BaseColor", 1, 0, 0, 1); - -var blueVariant = baseMaterial.Clone(); -blueVariant.SetVector4("_BaseColor", 0, 0, 1, 1); -``` - ---- - -## Extension Points - -### Custom Property Types - -Extend `MaterialPropertyBlock` for custom data: - -```csharp -public void SetCustomStruct(string name, T value) where T : unmanaged -{ - // Implementation -} -``` - -### Material Property Validation - -Add validation in `Material` setters: - -```csharp -public void SetFloat(string name, float value) -{ - if (value < 0 || value > 1) - throw new ArgumentOutOfRangeException(); - _propertyBlock.SetFloat(name, value); -} -``` - -### Custom Batching Strategies - -Subclass or compose with `MaterialBatchRenderer`: - -```csharp -public class DepthSortedBatchRenderer : MaterialBatchRenderer -{ - public override MaterialBatch[] BatchDrawCalls(...) - { - var batches = base.BatchDrawCalls(...); - // Custom depth sorting logic - return batches; - } -} -``` - ---- - -## Comparison to Other Engines - -| Feature | Ghost | Unity URP | Unreal 5 | Godot 4 | -|---------|-------|-----------|----------|---------| -| Keyword System | Global + Local | Global + Local | Static + Dynamic | Static | -| Multi-pass | Native | SubShader | Material Functions | Multi-pass | -| Per-pass Override | ✓ | Limited | ✓ | ✓ | -| Variant Caching | Auto | Auto | Auto | Auto | -| Batch Optimization | PSO-based | SRP Batcher | Nanite/VSM | Clustered | -| Unsafe/Native | ✓ | ✓ (Jobs) | ✓ (C++) | Limited | - ---- - -## Future Enhancements - -1. **GPU-Driven Rendering**: Indirect draws, culling on GPU -2. **Material Graphs**: Node-based shader authoring -3. **Hot Reload**: Runtime shader recompilation -4. **Texture Support**: Bindless textures, virtual texturing -5. **Compute Shaders**: Material property animation on GPU -6. **Serialization**: Material asset loading/saving - ---- - -## License - -This is a concept/demonstration project. Adapt as needed for your engine. diff --git a/Ghost.Shader.Concept/RenderState.cs b/Ghost.Shader.Concept/RenderState.cs deleted file mode 100644 index 02ffbcf..0000000 --- a/Ghost.Shader.Concept/RenderState.cs +++ /dev/null @@ -1,126 +0,0 @@ -using System.Runtime.InteropServices; - -namespace Ghost.Shader.Concept; - -/// -/// Render state configuration for pipeline creation. -/// Immutable and hashable for PSO caching. -/// -[StructLayout(LayoutKind.Sequential)] -public struct RenderState : IEquatable -{ - // Rasterizer State - public CullMode CullMode; - public FillMode FillMode; - public bool FrontCounterClockwise; - public float DepthBias; - public float SlopeScaledDepthBias; - - // Depth-Stencil State - public bool DepthTestEnable; - public bool DepthWriteEnable; - public CompareFunction DepthCompareFunc; - public bool StencilEnable; - public byte StencilReadMask; - public byte StencilWriteMask; - - // Blend State (per RT, simplified to single RT here) - public bool BlendEnable; - public BlendFactor SrcBlend; - public BlendFactor DestBlend; - public BlendOperation BlendOp; - public BlendFactor SrcBlendAlpha; - public BlendFactor DestBlendAlpha; - public BlendOperation BlendOpAlpha; - public ColorWriteMask ColorWriteMask; - - // Topology - public PrimitiveTopology Topology; - - public static RenderState Default => new() - { - CullMode = CullMode.Back, - FillMode = FillMode.Solid, - FrontCounterClockwise = false, - DepthTestEnable = true, - DepthWriteEnable = true, - DepthCompareFunc = CompareFunction.LessEqual, - StencilEnable = false, - StencilReadMask = 0xFF, - StencilWriteMask = 0xFF, - BlendEnable = false, - SrcBlend = BlendFactor.One, - DestBlend = BlendFactor.Zero, - BlendOp = BlendOperation.Add, - SrcBlendAlpha = BlendFactor.One, - DestBlendAlpha = BlendFactor.Zero, - BlendOpAlpha = BlendOperation.Add, - ColorWriteMask = ColorWriteMask.All, - Topology = PrimitiveTopology.TriangleList - }; - - public unsafe ulong ComputeHash() - { - fixed (RenderState* ptr = &this) - { - return ComputeHash64((byte*)ptr, sizeof(RenderState)); - } - } - - private static unsafe ulong ComputeHash64(byte* data, int length) - { - ulong hash = 0xcbf29ce484222325; - const ulong prime = 0x100000001b3; - for (int i = 0; i < length; i++) - { - hash ^= data[i]; - hash *= prime; - } - return hash; - } - - public bool Equals(RenderState other) - { - return CullMode == other.CullMode && - FillMode == other.FillMode && - FrontCounterClockwise == other.FrontCounterClockwise && - DepthBias == other.DepthBias && - SlopeScaledDepthBias == other.SlopeScaledDepthBias && - DepthTestEnable == other.DepthTestEnable && - DepthWriteEnable == other.DepthWriteEnable && - DepthCompareFunc == other.DepthCompareFunc && - StencilEnable == other.StencilEnable && - StencilReadMask == other.StencilReadMask && - StencilWriteMask == other.StencilWriteMask && - BlendEnable == other.BlendEnable && - SrcBlend == other.SrcBlend && - DestBlend == other.DestBlend && - BlendOp == other.BlendOp && - SrcBlendAlpha == other.SrcBlendAlpha && - DestBlendAlpha == other.DestBlendAlpha && - BlendOpAlpha == other.BlendOpAlpha && - ColorWriteMask == other.ColorWriteMask && - Topology == other.Topology; - } - - public override bool Equals(object? obj) => obj is RenderState other && Equals(other); - public override int GetHashCode() => (int)ComputeHash(); -} - -public enum CullMode : byte { None, Front, Back } -public enum FillMode : byte { Wireframe, Solid } -public enum CompareFunction : byte { Never, Less, Equal, LessEqual, Greater, NotEqual, GreaterEqual, Always } -public enum BlendFactor : byte { Zero, One, SrcColor, InvSrcColor, SrcAlpha, InvSrcAlpha, DestAlpha, InvDestAlpha, DestColor, InvDestColor } -public enum BlendOperation : byte { Add, Subtract, ReverseSubtract, Min, Max } -public enum PrimitiveTopology : byte { PointList, LineList, LineStrip, TriangleList, TriangleStrip } - -[Flags] -public enum ColorWriteMask : byte -{ - None = 0, - Red = 1, - Green = 2, - Blue = 4, - Alpha = 8, - All = Red | Green | Blue | Alpha -} diff --git a/Ghost.Shader.Concept/ShaderKeys.cs b/Ghost.Shader.Concept/ShaderKeys.cs deleted file mode 100644 index 8d6bbdf..0000000 --- a/Ghost.Shader.Concept/ShaderKeys.cs +++ /dev/null @@ -1,71 +0,0 @@ -using System.Runtime.InteropServices; - -namespace Ghost.Shader.Concept; - -/// -/// Unique identifier for a shader variant based on keyword combination. -/// Used as key for shader compilation cache. -/// -[StructLayout(LayoutKind.Sequential)] -public readonly struct ShaderVariantKey : IEquatable -{ - public readonly int ShaderProgramId; - public readonly ulong KeywordHash; - - public ShaderVariantKey(int shaderProgramId, ulong keywordHash) - { - ShaderProgramId = shaderProgramId; - KeywordHash = keywordHash; - } - - public bool Equals(ShaderVariantKey other) => - ShaderProgramId == other.ShaderProgramId && KeywordHash == other.KeywordHash; - - public override bool Equals(object? obj) => obj is ShaderVariantKey other && Equals(other); - public override int GetHashCode() => HashCode.Combine(ShaderProgramId, KeywordHash); -} - -/// -/// Unique identifier for a graphics pipeline state object. -/// Combines shader variant, render state, and pass information. -/// -[StructLayout(LayoutKind.Sequential)] -public readonly struct GraphicsPipelineKey : IEquatable -{ - public readonly ShaderVariantKey VariantKey; - public readonly ulong RenderStateHash; - public readonly int PassId; - - public GraphicsPipelineKey(ShaderVariantKey variantKey, ulong renderStateHash, int passId) - { - VariantKey = variantKey; - RenderStateHash = renderStateHash; - PassId = passId; - } - - public bool Equals(GraphicsPipelineKey other) => - VariantKey.Equals(other.VariantKey) && - RenderStateHash == other.RenderStateHash && - PassId == other.PassId; - - public override bool Equals(object? obj) => obj is GraphicsPipelineKey other && Equals(other); - public override int GetHashCode() => HashCode.Combine(VariantKey, RenderStateHash, PassId); -} - -/// -/// Mock interface for shader compiler (assumed to exist) -/// -public interface IShaderCompiler -{ - /// Compiles a shader variant for the given keyword set - IntPtr CompileVariant(ShaderVariantKey key, in KeywordSet keywords); -} - -/// -/// Mock interface for pipeline library (assumed to exist) -/// -public interface IPipelineLibrary -{ - /// Gets or creates a PSO for the given pipeline key - IntPtr GetOrCreatePipeline(in GraphicsPipelineKey key); -} diff --git a/Ghost.Shader.Concept/ShaderKeyword.cs b/Ghost.Shader.Concept/ShaderKeyword.cs deleted file mode 100644 index c330015..0000000 --- a/Ghost.Shader.Concept/ShaderKeyword.cs +++ /dev/null @@ -1,77 +0,0 @@ -namespace Ghost.Shader.Concept; - -/// -/// Represents a shader keyword that can toggle shader features. -/// Keywords are immutable and interned for fast comparison. -/// -public readonly struct ShaderKeyword : IEquatable -{ - private readonly int _id; - private readonly KeywordScope _scope; - - public int Id => _id; - public KeywordScope Scope => _scope; - public bool IsValid => _id >= 0; - - internal ShaderKeyword(int id, KeywordScope scope) - { - _id = id; - _scope = scope; - } - - public bool Equals(ShaderKeyword other) => _id == other._id && _scope == other._scope; - public override bool Equals(object? obj) => obj is ShaderKeyword other && Equals(other); - public override int GetHashCode() => HashCode.Combine(_id, _scope); - - public static bool operator ==(ShaderKeyword left, ShaderKeyword right) => left.Equals(right); - public static bool operator !=(ShaderKeyword left, ShaderKeyword right) => !left.Equals(right); -} - -public enum KeywordScope : byte -{ - /// Keywords set globally (e.g., platform, quality settings) - Global, - - /// Keywords set per-material instance - Local -} - -/// -/// Manages keyword registration and fast lookup. -/// Thread-safe for registration, lock-free for lookups. -/// -public sealed class ShaderKeywordRegistry -{ - private readonly Dictionary _keywords = new(); - private readonly Dictionary _idToName = new(); - private int _nextId = 0; - private readonly object _lock = new(); - - public static ShaderKeywordRegistry Instance { get; } = new(); - - private ShaderKeywordRegistry() { } - - public ShaderKeyword GetOrRegister(string name, KeywordScope scope) - { - string key = $"{scope}:{name}"; - - lock (_lock) - { - if (_keywords.TryGetValue(key, out var existing)) - return existing; - - var keyword = new ShaderKeyword(_nextId++, scope); - _keywords[key] = keyword; - _idToName[keyword.Id] = name; - return keyword; - } - } - - public string? GetName(ShaderKeyword keyword) - { - lock (_lock) - { - return _idToName.TryGetValue(keyword.Id, out var name) ? name : null; - } - } -} diff --git a/Ghost.Shader.Concept/ShaderProgram.cs b/Ghost.Shader.Concept/ShaderProgram.cs deleted file mode 100644 index bd60284..0000000 --- a/Ghost.Shader.Concept/ShaderProgram.cs +++ /dev/null @@ -1,122 +0,0 @@ -namespace Ghost.Shader.Concept; - -/// -/// Represents a single rendering pass within a shader program. -/// Each pass can have its own render state overrides. -/// -public sealed class ShaderPass -{ - public string Name { get; } - public int PassId { get; } - public RenderState RenderState { get; } - public string VertexEntryPoint { get; } - public string PixelEntryPoint { get; } - - public ShaderPass( - string name, - int passId, - RenderState renderState, - string vertexEntryPoint = "VSMain", - string pixelEntryPoint = "PSMain") - { - Name = name; - PassId = passId; - RenderState = renderState; - VertexEntryPoint = vertexEntryPoint; - PixelEntryPoint = pixelEntryPoint; - } -} - -/// -/// Shader program containing multiple passes and keyword declarations. -/// Immutable after creation for thread-safety. -/// -public sealed class ShaderProgram -{ - private static int _nextId = 0; - - public int Id { get; } - public string Name { get; } - public ShaderPass[] Passes { get; } - public ShaderKeyword[] DeclaredKeywords { get; } - - private readonly Dictionary _passNameToIndex = new(); - - public ShaderProgram( - string name, - ShaderPass[] passes, - ShaderKeyword[] declaredKeywords) - { - Id = Interlocked.Increment(ref _nextId); - Name = name; - Passes = passes; - DeclaredKeywords = declaredKeywords; - - for (int i = 0; i < passes.Length; i++) - { - _passNameToIndex[passes[i].Name] = i; - } - } - - public int GetPassIndex(string passName) - { - return _passNameToIndex.TryGetValue(passName, out int index) ? index : -1; - } - - public ShaderVariantKey CreateVariantKey(in KeywordSet keywords) - { - return new ShaderVariantKey(Id, keywords.ComputeHash()); - } -} - -/// -/// Builder pattern for creating shader programs fluently. -/// -public sealed class ShaderProgramBuilder -{ - private string _name = "Unnamed"; - private readonly List _passes = new(); - private readonly List _keywords = new(); - - public ShaderProgramBuilder WithName(string name) - { - _name = name; - return this; - } - - public ShaderProgramBuilder AddPass( - string passName, - RenderState? renderState = null, - string vertexEntry = "VSMain", - string pixelEntry = "PSMain") - { - var pass = new ShaderPass( - passName, - _passes.Count, - renderState ?? RenderState.Default, - vertexEntry, - pixelEntry); - _passes.Add(pass); - return this; - } - - public ShaderProgramBuilder DeclareKeyword(ShaderKeyword keyword) - { - _keywords.Add(keyword); - return this; - } - - public ShaderProgramBuilder DeclareKeywords(params ShaderKeyword[] keywords) - { - _keywords.AddRange(keywords); - return this; - } - - public ShaderProgram Build() - { - if (_passes.Count == 0) - throw new InvalidOperationException("Shader program must have at least one pass"); - - return new ShaderProgram(_name, _passes.ToArray(), _keywords.ToArray()); - } -} diff --git a/GhostEngine.slnx b/GhostEngine.slnx index 656a84e..1ad6552 100644 --- a/GhostEngine.slnx +++ b/GhostEngine.slnx @@ -34,7 +34,6 @@ -