docs: generated api docs for graphics

2026-03-28 15:35:54 +09:00
parent 419552439d
commit 095fcc87a7
173 changed files with 83450 additions and 29 deletions
--- a/docs/documents/api/Ghost.Graphics.RHI.PassRenderTargetDesc.yml
+++ b/docs/documents/api/Ghost.Graphics.RHI.PassRenderTargetDesc.yml
@@ -0,0 +1,520 @@
+### YamlMime:ManagedReference
+items:
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc
+  commentId: T:Ghost.Graphics.RHI.PassRenderTargetDesc
+  id: PassRenderTargetDesc
+  parent: Ghost.Graphics.RHI
+  children:
+  - Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+  - Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+  - Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+  - Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+  langs:
+  - csharp
+  - vb
+  name: PassRenderTargetDesc
+  nameWithType: PassRenderTargetDesc
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc
+  type: Struct
+  source:
+    remote:
+      path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+      branch: develop
+      repo: https://git.personalnas.com/Misaki/GhostEngine.git
+    id: PassRenderTargetDesc
+    path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+    startLine: 377
+  assemblies:
+  - Ghost.Graphics.RHI
+  namespace: Ghost.Graphics.RHI
+  syntax:
+    content: public struct PassRenderTargetDesc
+    content.vb: Public Structure PassRenderTargetDesc
+  inheritedMembers:
+  - System.ValueType.Equals(System.Object)
+  - System.ValueType.GetHashCode
+  - System.ValueType.ToString
+  - System.Object.Equals(System.Object,System.Object)
+  - System.Object.GetType
+  - System.Object.ReferenceEquals(System.Object,System.Object)
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+  commentId: P:Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+  id: Texture
+  parent: Ghost.Graphics.RHI.PassRenderTargetDesc
+  langs:
+  - csharp
+  - vb
+  name: Texture
+  nameWithType: PassRenderTargetDesc.Texture
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+  type: Property
+  source:
+    remote:
+      path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+      branch: develop
+      repo: https://git.personalnas.com/Misaki/GhostEngine.git
+    id: Texture
+    path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+    startLine: 379
+  assemblies:
+  - Ghost.Graphics.RHI
+  namespace: Ghost.Graphics.RHI
+  syntax:
+    content: public Handle<Texture> Texture { readonly get; set; }
+    parameters: []
+    return:
+      type: Ghost.Core.Handle{Ghost.Graphics.RHI.Texture}
+    content.vb: Public Property Texture As Handle(Of Texture)
+  overload: Ghost.Graphics.RHI.PassRenderTargetDesc.Texture*
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+  commentId: P:Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+  id: ClearColor
+  parent: Ghost.Graphics.RHI.PassRenderTargetDesc
+  langs:
+  - csharp
+  - vb
+  name: ClearColor
+  nameWithType: PassRenderTargetDesc.ClearColor
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+  type: Property
+  source:
+    remote:
+      path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+      branch: develop
+      repo: https://git.personalnas.com/Misaki/GhostEngine.git
+    id: ClearColor
+    path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+    startLine: 384
+  assemblies:
+  - Ghost.Graphics.RHI
+  namespace: Ghost.Graphics.RHI
+  syntax:
+    content: public Color128 ClearColor { readonly get; set; }
+    parameters: []
+    return:
+      type: Ghost.Graphics.RHI.Color128
+    content.vb: Public Property ClearColor As Color128
+  overload: Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor*
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+  commentId: P:Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+  id: LoadOp
+  parent: Ghost.Graphics.RHI.PassRenderTargetDesc
+  langs:
+  - csharp
+  - vb
+  name: LoadOp
+  nameWithType: PassRenderTargetDesc.LoadOp
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+  type: Property
+  source:
+    remote:
+      path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+      branch: develop
+      repo: https://git.personalnas.com/Misaki/GhostEngine.git
+    id: LoadOp
+    path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+    startLine: 392
+  assemblies:
+  - Ghost.Graphics.RHI
+  namespace: Ghost.Graphics.RHI
+  summary: Specifies how to load the render target at the start of the render pass.
+  example: []
+  syntax:
+    content: public AttachmentLoadOp LoadOp { readonly get; set; }
+    parameters: []
+    return:
+      type: Ghost.Graphics.RHI.AttachmentLoadOp
+    content.vb: Public Property LoadOp As AttachmentLoadOp
+  overload: Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp*
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+  commentId: P:Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+  id: StoreOp
+  parent: Ghost.Graphics.RHI.PassRenderTargetDesc
+  langs:
+  - csharp
+  - vb
+  name: StoreOp
+  nameWithType: PassRenderTargetDesc.StoreOp
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+  type: Property
+  source:
+    remote:
+      path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+      branch: develop
+      repo: https://git.personalnas.com/Misaki/GhostEngine.git
+    id: StoreOp
+    path: src/Runtime/Ghost.Graphics.RHI/Common.cs
+    startLine: 400
+  assemblies:
+  - Ghost.Graphics.RHI
+  namespace: Ghost.Graphics.RHI
+  summary: Specifies how to store the render target at the end of the render pass.
+  example: []
+  syntax:
+    content: public AttachmentStoreOp StoreOp { readonly get; set; }
+    parameters: []
+    return:
+      type: Ghost.Graphics.RHI.AttachmentStoreOp
+    content.vb: Public Property StoreOp As AttachmentStoreOp
+  overload: Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp*
+references:
+- uid: Ghost.Graphics.RHI
+  commentId: N:Ghost.Graphics.RHI
+  href: Ghost.html
+  name: Ghost.Graphics.RHI
+  nameWithType: Ghost.Graphics.RHI
+  fullName: Ghost.Graphics.RHI
+  spec.csharp:
+  - uid: Ghost
+    name: Ghost
+    href: Ghost.html
+  - name: .
+  - uid: Ghost.Graphics
+    name: Graphics
+    href: Ghost.Graphics.html
+  - name: .
+  - uid: Ghost.Graphics.RHI
+    name: RHI
+    href: Ghost.Graphics.RHI.html
+  spec.vb:
+  - uid: Ghost
+    name: Ghost
+    href: Ghost.html
+  - name: .
+  - uid: Ghost.Graphics
+    name: Graphics
+    href: Ghost.Graphics.html
+  - name: .
+  - uid: Ghost.Graphics.RHI
+    name: RHI
+    href: Ghost.Graphics.RHI.html
+- uid: System.ValueType.Equals(System.Object)
+  commentId: M:System.ValueType.Equals(System.Object)
+  parent: System.ValueType
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
+  name: Equals(object)
+  nameWithType: ValueType.Equals(object)
+  fullName: System.ValueType.Equals(object)
+  nameWithType.vb: ValueType.Equals(Object)
+  fullName.vb: System.ValueType.Equals(Object)
+  name.vb: Equals(Object)
+  spec.csharp:
+  - uid: System.ValueType.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
+  - name: (
+  - uid: System.Object
+    name: object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+  spec.vb:
+  - uid: System.ValueType.Equals(System.Object)
+    name: Equals
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.equals
+  - name: (
+  - uid: System.Object
+    name: Object
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.object
+  - name: )
+- uid: System.ValueType.GetHashCode
+  commentId: M:System.ValueType.GetHashCode
+  parent: System.ValueType
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
+  name: GetHashCode()
+  nameWithType: ValueType.GetHashCode()
+  fullName: System.ValueType.GetHashCode()
+  spec.csharp:
+  - uid: System.ValueType.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.ValueType.GetHashCode
+    name: GetHashCode
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode
+  - name: (
+  - name: )
+- uid: System.ValueType.ToString
+  commentId: M:System.ValueType.ToString
+  parent: System.ValueType
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
+  name: ToString()
+  nameWithType: ValueType.ToString()
+  fullName: System.ValueType.ToString()
+  spec.csharp:
+  - uid: System.ValueType.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
+  - name: (
+  - name: )
+  spec.vb:
+  - uid: System.ValueType.ToString
+    name: ToString
+    isExternal: true
+    href: https://learn.microsoft.com/dotnet/api/system.valuetype.tostring
+  - name: (
+  - 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.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.ValueType
+  commentId: T:System.ValueType
+  parent: System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system.valuetype
+  name: ValueType
+  nameWithType: ValueType
+  fullName: System.ValueType
+- 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
+  commentId: N:System
+  isExternal: true
+  href: https://learn.microsoft.com/dotnet/api/system
+  name: System
+  nameWithType: System
+  fullName: System
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.Texture*
+  commentId: Overload:Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+  href: Ghost.Graphics.RHI.PassRenderTargetDesc.html#Ghost_Graphics_RHI_PassRenderTargetDesc_Texture
+  name: Texture
+  nameWithType: PassRenderTargetDesc.Texture
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.Texture
+- uid: Ghost.Core.Handle{Ghost.Graphics.RHI.Texture}
+  commentId: T:Ghost.Core.Handle{Ghost.Graphics.RHI.Texture}
+  parent: Ghost.Core
+  definition: Ghost.Core.Handle`1
+  href: Ghost.Graphics.RHI.Texture.html
+  name: Handle<Texture>
+  nameWithType: Handle<Texture>
+  fullName: Ghost.Core.Handle<Ghost.Graphics.RHI.Texture>
+  nameWithType.vb: Handle(Of Texture)
+  fullName.vb: Ghost.Core.Handle(Of Ghost.Graphics.RHI.Texture)
+  name.vb: Handle(Of Texture)
+  spec.csharp:
+  - uid: Ghost.Core.Handle`1
+    name: Handle
+  - name: <
+  - uid: Ghost.Graphics.RHI.Texture
+    name: Texture
+    href: Ghost.Graphics.RHI.Texture.html
+  - name: '>'
+  spec.vb:
+  - uid: Ghost.Core.Handle`1
+    name: Handle
+  - name: (
+  - name: Of
+  - name: " "
+  - uid: Ghost.Graphics.RHI.Texture
+    name: Texture
+    href: Ghost.Graphics.RHI.Texture.html
+  - name: )
+- uid: Ghost.Core.Handle`1
+  commentId: T:Ghost.Core.Handle`1
+  name: Handle<T>
+  nameWithType: Handle<T>
+  fullName: Ghost.Core.Handle<T>
+  nameWithType.vb: Handle(Of T)
+  fullName.vb: Ghost.Core.Handle(Of T)
+  name.vb: Handle(Of T)
+  spec.csharp:
+  - uid: Ghost.Core.Handle`1
+    name: Handle
+  - name: <
+  - name: T
+  - name: '>'
+  spec.vb:
+  - uid: Ghost.Core.Handle`1
+    name: Handle
+  - name: (
+  - name: Of
+  - name: " "
+  - name: T
+  - name: )
+- uid: Ghost.Core
+  commentId: N:Ghost.Core
+  name: Ghost.Core
+  nameWithType: Ghost.Core
+  fullName: Ghost.Core
+  spec.csharp:
+  - uid: Ghost
+    name: Ghost
+  - name: .
+  - uid: Ghost.Core
+    name: Core
+  spec.vb:
+  - uid: Ghost
+    name: Ghost
+  - name: .
+  - uid: Ghost.Core
+    name: Core
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor*
+  commentId: Overload:Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+  href: Ghost.Graphics.RHI.PassRenderTargetDesc.html#Ghost_Graphics_RHI_PassRenderTargetDesc_ClearColor
+  name: ClearColor
+  nameWithType: PassRenderTargetDesc.ClearColor
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.ClearColor
+- uid: Ghost.Graphics.RHI.Color128
+  commentId: T:Ghost.Graphics.RHI.Color128
+  parent: Ghost.Graphics.RHI
+  href: Ghost.Graphics.RHI.Color128.html
+  name: Color128
+  nameWithType: Color128
+  fullName: Ghost.Graphics.RHI.Color128
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp*
+  commentId: Overload:Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+  href: Ghost.Graphics.RHI.PassRenderTargetDesc.html#Ghost_Graphics_RHI_PassRenderTargetDesc_LoadOp
+  name: LoadOp
+  nameWithType: PassRenderTargetDesc.LoadOp
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.LoadOp
+- uid: Ghost.Graphics.RHI.AttachmentLoadOp
+  commentId: T:Ghost.Graphics.RHI.AttachmentLoadOp
+  parent: Ghost.Graphics.RHI
+  href: Ghost.Graphics.RHI.AttachmentLoadOp.html
+  name: AttachmentLoadOp
+  nameWithType: AttachmentLoadOp
+  fullName: Ghost.Graphics.RHI.AttachmentLoadOp
+- uid: Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp*
+  commentId: Overload:Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+  href: Ghost.Graphics.RHI.PassRenderTargetDesc.html#Ghost_Graphics_RHI_PassRenderTargetDesc_StoreOp
+  name: StoreOp
+  nameWithType: PassRenderTargetDesc.StoreOp
+  fullName: Ghost.Graphics.RHI.PassRenderTargetDesc.StoreOp
+- uid: Ghost.Graphics.RHI.AttachmentStoreOp
+  commentId: T:Ghost.Graphics.RHI.AttachmentStoreOp
+  parent: Ghost.Graphics.RHI
+  href: Ghost.Graphics.RHI.AttachmentStoreOp.html
+  name: AttachmentStoreOp
+  nameWithType: AttachmentStoreOp
+  fullName: Ghost.Graphics.RHI.AttachmentStoreOp