Files
GhostEngine/docs/documents/api/Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.yml

478 lines
16 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
commentId: T:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
id: RenderGraphBlackboard
parent: Ghost.Graphics.RenderGraphModule
children:
- Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add``1(``0)
- Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear
- Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get``1
- Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet``1(``0@)
langs:
- csharp
- vb
name: RenderGraphBlackboard
nameWithType: RenderGraphBlackboard
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
type: Class
source:
remote:
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
branch: develop
repo: https://git.personalnas.com/Misaki/GhostEngine.git
id: RenderGraphBlackboard
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
startLine: 7
assemblies:
- Ghost.Graphics
namespace: Ghost.Graphics.RenderGraphModule
summary: >-
Blackboard for sharing data between render passes.
Uses a dictionary with type keys to store different pass data types.
Avoids allocations by reusing the same dictionary across frames.
example: []
syntax:
content: public sealed class RenderGraphBlackboard
content.vb: Public NotInheritable Class RenderGraphBlackboard
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add``1(``0)
commentId: M:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add``1(``0)
id: Add``1(``0)
parent: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
langs:
- csharp
- vb
name: Add<T>(T)
nameWithType: RenderGraphBlackboard.Add<T>(T)
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add<T>(T)
type: Method
source:
remote:
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
branch: develop
repo: https://git.personalnas.com/Misaki/GhostEngine.git
id: Add
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
startLine: 14
assemblies:
- Ghost.Graphics
namespace: Ghost.Graphics.RenderGraphModule
summary: Adds or updates pass data in the blackboard.
example: []
syntax:
content: 'public void Add<T>(T data) where T : class, IPassData'
parameters:
- id: data
type: '{T}'
typeParameters:
- id: T
content.vb: Public Sub Add(Of T As {Class, IPassData})(data As T)
overload: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add*
nameWithType.vb: RenderGraphBlackboard.Add(Of T)(T)
fullName.vb: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add(Of T)(T)
name.vb: Add(Of T)(T)
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get``1
commentId: M:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get``1
id: Get``1
parent: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
langs:
- csharp
- vb
name: Get<T>()
nameWithType: RenderGraphBlackboard.Get<T>()
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get<T>()
type: Method
source:
remote:
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
branch: develop
repo: https://git.personalnas.com/Misaki/GhostEngine.git
id: Get
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
startLine: 24
assemblies:
- Ghost.Graphics
namespace: Ghost.Graphics.RenderGraphModule
summary: Retrieves pass data from the blackboard.
example: []
syntax:
content: 'public T Get<T>() where T : class, IPassData'
typeParameters:
- id: T
return:
type: '{T}'
content.vb: Public Function [Get](Of T As {Class, IPassData})() As T
overload: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get*
nameWithType.vb: RenderGraphBlackboard.Get(Of T)()
fullName.vb: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get(Of T)()
name.vb: Get(Of T)()
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet``1(``0@)
commentId: M:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet``1(``0@)
id: TryGet``1(``0@)
parent: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
langs:
- csharp
- vb
name: TryGet<T>(out T?)
nameWithType: RenderGraphBlackboard.TryGet<T>(out T?)
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet<T>(out T?)
type: Method
source:
remote:
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
branch: develop
repo: https://git.personalnas.com/Misaki/GhostEngine.git
id: TryGet
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
startLine: 39
assemblies:
- Ghost.Graphics
namespace: Ghost.Graphics.RenderGraphModule
summary: Tries to get pass data from the blackboard.
example: []
syntax:
content: 'public bool TryGet<T>(out T? data) where T : class, IPassData'
parameters:
- id: data
type: '{T}'
typeParameters:
- id: T
return:
type: System.Boolean
content.vb: Public Function TryGet(Of T As {Class, IPassData})(data As T) As Boolean
overload: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet*
nameWithType.vb: RenderGraphBlackboard.TryGet(Of T)(T)
fullName.vb: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet(Of T)(T)
name.vb: TryGet(Of T)(T)
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear
commentId: M:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear
id: Clear
parent: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard
langs:
- csharp
- vb
name: Clear()
nameWithType: RenderGraphBlackboard.Clear()
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear()
type: Method
source:
remote:
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
branch: develop
repo: https://git.personalnas.com/Misaki/GhostEngine.git
id: Clear
path: src/Runtime/Ghost.Graphics/RenderGraphModule/RenderGraphBlackboard.cs
startLine: 57
assemblies:
- Ghost.Graphics
namespace: Ghost.Graphics.RenderGraphModule
summary: >-
Clears all data from the blackboard.
Does not deallocate the backing dictionary to avoid allocations.
example: []
syntax:
content: public void Clear()
content.vb: Public Sub Clear()
overload: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear*
references:
- uid: Ghost.Graphics.RenderGraphModule
commentId: N:Ghost.Graphics.RenderGraphModule
href: Ghost.html
name: Ghost.Graphics.RenderGraphModule
nameWithType: Ghost.Graphics.RenderGraphModule
fullName: Ghost.Graphics.RenderGraphModule
spec.csharp:
- uid: Ghost
name: Ghost
href: Ghost.html
- name: .
- uid: Ghost.Graphics
name: Graphics
href: Ghost.Graphics.html
- name: .
- uid: Ghost.Graphics.RenderGraphModule
name: RenderGraphModule
href: Ghost.Graphics.RenderGraphModule.html
spec.vb:
- uid: Ghost
name: Ghost
href: Ghost.html
- name: .
- uid: Ghost.Graphics
name: Graphics
href: Ghost.Graphics.html
- name: .
- uid: Ghost.Graphics.RenderGraphModule
name: RenderGraphModule
href: Ghost.Graphics.RenderGraphModule.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add*
commentId: Overload:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add
href: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.html#Ghost_Graphics_RenderGraphModule_RenderGraphBlackboard_Add__1___0_
name: Add
nameWithType: RenderGraphBlackboard.Add
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Add
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get*
commentId: Overload:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get
href: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.html#Ghost_Graphics_RenderGraphModule_RenderGraphBlackboard_Get__1
name: Get
nameWithType: RenderGraphBlackboard.Get
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Get
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet*
commentId: Overload:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet
href: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.html#Ghost_Graphics_RenderGraphModule_RenderGraphBlackboard_TryGet__1___0__
name: TryGet
nameWithType: RenderGraphBlackboard.TryGet
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.TryGet
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear*
commentId: Overload:Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear
href: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.html#Ghost_Graphics_RenderGraphModule_RenderGraphBlackboard_Clear
name: Clear
nameWithType: RenderGraphBlackboard.Clear
fullName: Ghost.Graphics.RenderGraphModule.RenderGraphBlackboard.Clear