DirectX / HLSL Source Backend

DirectX HLSL source backend exports for CrossGL Translator.

DirectX/HLSL AST Node definitions

class crosstl.backend.DirectX.DirectxAst.CbufferNode(name, members)

Bases: StructNode

HLSL constant-buffer declaration with named member variables.

class crosstl.backend.DirectX.DirectxAst.IncludeNode(path, is_system=False)

Bases: ASTNode

HLSL include directive with system/local include metadata.

class crosstl.backend.DirectX.DirectxAst.PragmaNode(directive, value=None)

Bases: ASTNode

Preprocessor pragma directive preserved in the HLSL AST.

class crosstl.backend.DirectX.DirectxAst.SwitchCaseNode(case_value, statements, is_default=False)

Bases: ASTNode

Legacy switch case node with default-case tracking.

class crosstl.backend.DirectX.DirectxAst.SwitchStatementNode(expression, cases)

Bases: ASTNode

Legacy switch statement node used by older HLSL parser paths.

Lexer for importing HLSL source into CrossGL Translator.

class crosstl.backend.DirectX.DirectxLexer.HLSLLexer(code, preprocess=True, file_path=None, include_paths=None, defines=None, strict_preprocessor=False)

Bases: object

Tokenize High-Level Shading Language source for the DirectX parser.

classmethod from_file(filepath)

Create a lexer instance from a source file.

Return type:

HLSLLexer

token_generator()

Yield HLSL tokens while skipping whitespace and comments.

Return type:

Iterator[Tuple[str, str]]

tokenize()

Return the full token stream as (token_type, text) tuples.

Return type:

List[Tuple[str, str]]

class crosstl.backend.DirectX.DirectxLexer.Lexer(input_str)

Bases: object

Compatibility wrapper around HLSLLexer for legacy code

next()

Return the next token and advance the cursor.

Return type:

Tuple[str, str]

peek()

Return the next token without advancing the cursor.

Return type:

Tuple[str, str]

reset()

Reset the cursor to the beginning of the token stream.

class crosstl.backend.DirectX.DirectxLexer.Token(token_type, text)

Bases: object

Simple typed token object used by DirectX compatibility paths.

class crosstl.backend.DirectX.DirectxLexer.TokenType(value)

Bases: Enum

Token names emitted by the HLSL lexer.

Parser for DirectX HLSL source AST construction.

class crosstl.backend.DirectX.DirectxParser.HLSLParser(tokens)

Bases: object

Parse HLSL tokens into the DirectX backend shader AST.

eat(expected_type)

Consume and return the current token when it matches expected_type.

parse()

Parse the complete token stream into a ShaderNode.

peek(offset=1)

Return a lookahead token without advancing the parser.

Reverse code generator that emits CrossGL from HLSL AST nodes.

class crosstl.backend.DirectX.DirectxCrossGLCodeGen.HLSLToCrossGLConverter

Bases: object

Serialize DirectX backend AST nodes back into CrossGL source.

generate(ast)

Generate a complete CrossGL shader from a parsed HLSL AST.

generate_expression(expr, is_main=False)

Render a DirectX backend expression node as CrossGL syntax.

generate_function(func, indent=1)

Render one HLSL function node as a CrossGL function block.

generate_statement(node)

Render one DirectX backend statement node as CrossGL source.

map_semantic(semantic)

Map an HLSL semantic to CrossGL semantic annotation syntax.

map_type(hlsl_type)

Map an HLSL type name to the closest CrossGL type name.

Preprocessor support for DirectX HLSL source imports.

class crosstl.backend.DirectX.preprocessor.HLSLPreprocessor(include_paths=None, defines=None, strict=False, max_expansion_depth=64)

Bases: object

Small HLSL preprocessor used before lexing imported source files.

class crosstl.backend.DirectX.preprocessor.Macro(name, params=None, replacement='', is_variadic=False)

Bases: object

Object-like or function-like HLSL preprocessor macro.