fix: Xml Comments - Update 4 (#2170)
* feat: Release.yml added for PR categorisation * Categories updated * fix: Typos fixed * fix: External link to Draw vertics manual added * fix: cref links references corrected * feat: cref corrected * fix: cref corrected or replaced * fix: cref corrected, pointing to the class base * fix: Entity Add xml corrected * fix: xml comments corrected * fix: cref corrected * fix: xml comment Tags reference corrected * fix: xml comment cref fixed and typos fixed * fix: Broken cref link removed * fix: cref references fixed * fix: xml comment updated, non existing SkyboxComponent component replaced with BackgroundComponent * fix: xml comment cref corrected * fix: xml comment private const moved out of cref * fix: Incorrect cref referencs updated * fix: The same namespace but different assembly, can't be done. Moved out out cref * fix: Cref references corrcted * fix: cref pointing to base added * fix: Cref references corrected * fix: cref removed, not working * fix: cref corrected or removed * fix: Cref corrections or removing cref * fix: LoadLibrary doesn't exist, changed to PreloadLibrary * fix: Missing namespace added * fix: Class name corrected * fix: Missing cref added * fix: Incorrect cref fixed
This commit is contained in:
Vaclav Elias
GitHub
Родитель
0e053a3b88
Коммит
dc9ceb4829
|
|
@ -12,7 +12,7 @@ using Stride.Core.Reflection;
|
|||
namespace Stride.Core.Assets.Analysis
|
||||
{
|
||||
/// <summary>
|
||||
/// An analysis to validate that all assets in a package have a valid <see cref="Asset.Base"/>.
|
||||
/// An analysis to validate that all assets in a package have a valid <see cref="Asset"/> base.
|
||||
/// In order to be valid, this analysis must be run after a <see cref="PackageAnalysis"/>
|
||||
/// </summary>
|
||||
public sealed class AssetBaseAnalysis : PackageSessionAnalysisBase
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace Stride.Core.Assets.Compiler
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the build steps generated for the build engine. This can be null if <see cref="LoggerResult.HasErrors"/> is true.
|
||||
/// Gets or sets the build steps generated for the build engine. This can be null if <see cref="Logger.HasErrors"/> is true.
|
||||
/// </summary>
|
||||
/// <value>The build step.</value>
|
||||
public ListBuildStep BuildSteps { get { return buildSteps; } set { if (value == null) throw new ArgumentNullException("value", @"The BuildSteps property cannot be set to null"); buildSteps = value; } }
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ using Stride.Core.Diagnostics;
|
|||
namespace Stride.Core.Assets
|
||||
{
|
||||
/// <summary>
|
||||
/// Result returned when loading a session using <see cref="PackageSession.Load(string,PackageSessionResult,System.Nullable{System.Threading.CancellationToken},bool)"/>
|
||||
/// Result returned when loading a session using <see cref="PackageSession.Load(string, PackageLoadParameters)"/>
|
||||
/// </summary>
|
||||
public sealed class PackageSessionResult : LoggerResult
|
||||
{
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ namespace Stride.Core.Assets.Serializers
|
|||
/// An implementation of <see cref="IAssetPartReference"/> that represents an asset part implementing <see cref="IIdentifiable"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This type is the default type used when <see cref="AssetPartReferenceAttribute.ReferenceType"/> is undefined.
|
||||
/// This type is the default type used when `AssetPartReferenceAttribute.ReferenceType` is undefined.
|
||||
/// </remarks>
|
||||
[DataContract]
|
||||
[DataStyle(DataStyle.Compact)]
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ using Stride.Core.Yaml;
|
|||
namespace Stride.Core.Assets
|
||||
{
|
||||
/// <summary>
|
||||
/// Removes objects implementing <see cref="IYamlProxy"/> from the object.
|
||||
/// Removes objects implementing 'IYamlProxy' from the object.
|
||||
/// </summary>
|
||||
public class UnloadableObjectRemover : AssetVisitorBase
|
||||
{
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ namespace Stride.Core.MicroThreading
|
|||
/// Provides a communication mechanism between <see cref="MicroThread"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <see cref="MicroThread"/> can send and receive to a <see cref="Channel"/>. Depending on the <see cref="Channel.Preference"/>,
|
||||
/// <see cref="MicroThread"/> can send and receive to a <see cref="Channel{T}"/>. Depending on the <see cref="Channel{T}.Preference"/>,
|
||||
/// sending or receiving <see cref="MicroThread"/> might be suspended and yield execution to another <see cref="MicroThread"/>.
|
||||
/// </remarks>
|
||||
/// <typeparam name="T">The type of element handled by this channel.</typeparam>
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ namespace Stride.Core.Storage
|
|||
/// <summary>
|
||||
/// Creates a stream that will be saved to database when closed and/or disposed.
|
||||
/// </summary>
|
||||
/// <returns>a stream writer that should be passed to <see cref="SaveStream"/> in order to be stored in the database</returns>
|
||||
/// <returns>a stream writer that should be passed to <see cref="Write"/> in order to be stored in the database</returns>
|
||||
OdbStreamWriter CreateStream();
|
||||
|
||||
/// <summary>
|
||||
|
|
|
|||
|
|
@ -318,9 +318,9 @@ namespace Stride.Core.Storage
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Creates a stream that can then be saved directly in the database using <see cref="SaveStream"/>.
|
||||
/// Creates a stream that can then be saved directly in the database using <see cref="Write"/>.
|
||||
/// </summary>
|
||||
/// <returns>a stream writer that should be passed to <see cref="SaveStream"/> in order to be stored in the database</returns>
|
||||
/// <returns>a stream writer that should be passed to <see cref="Write"/> in order to be stored in the database</returns>
|
||||
public OdbStreamWriter CreateStream()
|
||||
{
|
||||
return backendWrite.CreateStream();
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ namespace Stride.Core.Collections
|
|||
public object Item { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the previous value. Only valid if <see cref="Action"/> is <see cref="NotifyCollectionChangedAction.Add"/> and <see cref=""/>
|
||||
/// Gets the previous value. Only valid if <see cref="Action"/> is <see cref="NotifyCollectionChangedAction.Add"/> and <see cref="NotifyCollectionChangedAction.Remove"/>
|
||||
/// </summary>
|
||||
public object OldItem { get; private set; }
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ namespace Stride.Core.Collections
|
|||
public object Item { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the previous value. Only valid if <see cref="Action"/> is <see cref="NotifyCollectionChangedAction.Add"/> and <see cref=""/>
|
||||
/// Gets the previous value. Only valid if <see cref="Action"/> is <see cref="NotifyCollectionChangedAction.Add"/> and <see cref="NotifyCollectionChangedAction.Remove"/>
|
||||
/// </summary>
|
||||
public object OldItem { get; private set; }
|
||||
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ namespace Stride.Core.Diagnostics
|
|||
public string TypeFullName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the name of the exception type. Should correspond to the <see cref="Type.Name"/> property of the exception type.
|
||||
/// Gets or sets the name of the exception type. Should correspond to the <see cref="MemberInfo.Name"/> property of the exception type.
|
||||
/// </summary>
|
||||
public string TypeName { get; set; }
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ namespace Stride.Core.Diagnostics
|
|||
/// A profiler state contains information of a portion of code being profiled. See remarks.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This struct is not intended to be used directly but only through <see cref="Profiler.Begin()"/>.
|
||||
/// This struct is not intended to be used directly but only through <see cref="Profiler.Begin"/>.
|
||||
/// You can still attach some attributes to it while profiling a portion of code.
|
||||
/// </remarks>
|
||||
public struct ProfilingState : IDisposable
|
||||
|
|
|
|||
|
|
@ -159,7 +159,7 @@ namespace Stride.Core
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// UnLoad a specific native dynamic library loaded previously by <see cref="LoadLibrary" />.
|
||||
/// UnLoad a specific native dynamic library loaded previously by <see cref="PreloadLibrary" />.
|
||||
/// </summary>
|
||||
/// <param name="libraryName">Name of the library to unload.</param>
|
||||
public static void UnLoad(string libraryName)
|
||||
|
|
@ -178,7 +178,7 @@ namespace Stride.Core
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// UnLoad all native dynamic library loaded previously by <see cref="LoadLibrary"/>.
|
||||
/// UnLoad all native dynamic library loaded previously by <see cref="PreloadLibrary"/>.
|
||||
/// </summary>
|
||||
public static void UnLoadAll()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ namespace Stride.Audio
|
|||
/// In current version, the audio engine necessarily creates its context on the default audio hardware of the device.
|
||||
/// The audio engine is required when creating or loading sounds.
|
||||
/// </summary>
|
||||
/// <remarks/>The AudioEngine is Disposable. Call the <see cref="ComponentBase.Dispose"/> function when you do not need to play sounds anymore to free memory allocated to the audio system.
|
||||
/// A call to Dispose automatically stops and disposes all the <see cref="SoundBase"/>, <see cref="SoundInstance"/>
|
||||
/// <remarks>The AudioEngine is Disposable. Call the <see cref="DisposeBase.Dispose"/> function when you do not need to play sounds anymore to free memory allocated to the audio system.
|
||||
/// A call to Dispose automatically stops and disposes all the <see cref="SoundBase"/>, <see cref="SoundInstance"/>.</remarks>
|
||||
public class AudioEngine : ComponentBase
|
||||
{
|
||||
public AudioListener DefaultListener;
|
||||
|
|
@ -89,7 +89,7 @@ namespace Stride.Audio
|
|||
AudioLayer.Destroy(AudioDevice);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// The list of the sounds that have been paused by the call to <see cref="PauseAudio"/> and should be resumed by <see cref="ResumeAudio"/>.
|
||||
/// </summary>
|
||||
|
|
@ -101,7 +101,7 @@ namespace Stride.Audio
|
|||
internal uint AudioSampleRate { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Method that updates all the sounds play status.
|
||||
/// Method that updates all the sounds play status.
|
||||
/// </summary>
|
||||
/// <remarks>Should be called in same thread as user main thread.</remarks>
|
||||
/// <exception cref="InvalidOperationException">One or several of the sounds asked for play had invalid data (corrupted or unsupported formats).</exception>
|
||||
|
|
@ -182,7 +182,7 @@ namespace Stride.Audio
|
|||
}
|
||||
}
|
||||
|
||||
private readonly List<SoundBase> notDisposedSounds = new List<SoundBase>();
|
||||
private readonly List<SoundBase> notDisposedSounds = new List<SoundBase>();
|
||||
|
||||
internal void RegisterSound(SoundBase newSound)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ namespace Stride.Audio
|
|||
{
|
||||
/// <summary>
|
||||
/// Interface for a playable sound.
|
||||
/// A playable sound can loop (ref <see cref="IsLooped"/>), be played (ref <see cref="Play"/>), be paused (ref <see cref="Pause"/>), be resumed (ref <see cref="Play"/>),
|
||||
/// A playable sound can loop (ref <see cref="IsLooping"/>), be played (ref <see cref="Play"/>), be paused (ref <see cref="Pause"/>), be resumed (ref <see cref="Play"/>),
|
||||
/// be stopped (ref <see cref="Stop()"/>) and be attenuated (ref <see cref="Volume"/>).
|
||||
/// To query the current state of a sound use the <see cref="PlayState"/> property.
|
||||
/// To stop a sound after its currently loop use <see cref="ExitLoop"/>
|
||||
/// To stop a sound after its currently loop set `IsLooping = false;`
|
||||
/// </summary>
|
||||
public interface IPlayableSound
|
||||
{
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ namespace Stride.Animations
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData.Time"/>
|
||||
/// Shifts all animation keys by the specified time, adding it to all <see cref="KeyFrameData{T}.Time". />
|
||||
/// </summary>
|
||||
/// <param name="shiftTimeSpan">The time span by which the keys should be shifted</param>
|
||||
public virtual void ShiftKeys(CompressedTimeSpan shiftTimeSpan) { }
|
||||
|
|
|
|||
|
|
@ -160,10 +160,10 @@ namespace Stride.Engine
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Adds the specified component using the <see cref="EntityComponent.DefaultKey" />.
|
||||
/// Adds the specified component to the entity.
|
||||
/// </summary>
|
||||
/// <param name="component">The component.</param>
|
||||
/// <exception cref="System.ArgumentNullException">component</exception>
|
||||
/// <param name="component">The component to add.</param>
|
||||
/// <exception cref="System.ArgumentNullException">Thrown if the component is null.</exception>
|
||||
public void Add(EntityComponent component)
|
||||
{
|
||||
Components.Add(component);
|
||||
|
|
|
|||
|
|
@ -23,17 +23,17 @@ namespace Stride.Engine
|
|||
public sealed class SceneInstance : EntityManager
|
||||
{
|
||||
/// <summary>
|
||||
/// A property key to get the current scene from the <see cref="RenderContext.Tags"/>.
|
||||
/// A property key to get the current scene from the <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<SceneInstance> Current = new PropertyKey<SceneInstance>("SceneInstance.Current", typeof(SceneInstance));
|
||||
|
||||
/// <summary>
|
||||
/// A property key to get the current render system from the <see cref="RenderContext.Tags"/>.
|
||||
/// A property key to get the current render system from the <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<RenderSystem> CurrentRenderSystem = new PropertyKey<RenderSystem>("SceneInstance.CurrentRenderSystem", typeof(SceneInstance));
|
||||
|
||||
/// <summary>
|
||||
/// A property key to get the current visibility group from the <see cref="RenderContext.Tags"/>.
|
||||
/// A property key to get the current visibility group from the <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<VisibilityGroup> CurrentVisibilityGroup = new PropertyKey<VisibilityGroup>("SceneInstance.CurrentVisibilityGroup", typeof(SceneInstance));
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ namespace Stride.Rendering
|
|||
public static class CameraComponentRendererExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Property key to access the current collection of <see cref="CameraComponent"/> from <see cref="RenderContext.Tags"/>.
|
||||
/// Property key to access the current collection of <see cref="CameraComponent"/> from <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<CameraComponent> Current = new PropertyKey<CameraComponent>("CameraComponentRenderer.CurrentCamera", typeof(RenderContext));
|
||||
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace Stride.Rendering.Compositing
|
|||
public class GraphicsCompositor : RendererBase
|
||||
{
|
||||
/// <summary>
|
||||
/// A property key to get the current <see cref="GraphicsCompositor"/> from the <see cref="RenderContext.Tags"/>.
|
||||
/// A property key to get the current <see cref="GraphicsCompositor"/> from the <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<GraphicsCompositor> Current = new PropertyKey<GraphicsCompositor>("GraphicsCompositor.Current", typeof(GraphicsCompositor));
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ namespace Stride.Rendering.Compositing
|
|||
public sealed class SceneCameraSlotCollection : FastTrackingCollection<SceneCameraSlot>
|
||||
{
|
||||
/// <summary>
|
||||
/// Property key to access the current collection of <see cref="CameraComponent"/> from <see cref="RenderContext.Tags"/>.
|
||||
/// Property key to access the current collection of <see cref="CameraComponent"/> from <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<SceneCameraSlotCollection> Current = new PropertyKey<SceneCameraSlotCollection>("SceneCameraSlotCollection.Current", typeof(SceneCameraSlotCollection));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,14 +17,14 @@ namespace Stride.Games
|
|||
{
|
||||
#region Initialization
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="GameForm"/> class.
|
||||
/// Initializes a new instance of the 'GameForm' class.
|
||||
/// </summary>
|
||||
public GameFormSDL() : this(GameContext.ProductName)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="GameForm"/> class.
|
||||
/// Initializes a new instance of the 'GameForm' class.
|
||||
/// </summary>
|
||||
/// <param name="text">The text.</param>
|
||||
public GameFormSDL(string text) : base(text)
|
||||
|
|
|
|||
|
|
@ -24,12 +24,12 @@
|
|||
namespace Stride.Games
|
||||
{
|
||||
/// <summary>
|
||||
/// Type of a <see cref="GameContext"/>.
|
||||
/// Type of a `GameContext`.
|
||||
/// </summary>
|
||||
public enum AppContextType
|
||||
{
|
||||
/// <summary>
|
||||
/// Game running on desktop in a form or <see cref="System.Windows.Forms.Control"/>.
|
||||
/// Game running on desktop in a form or <see cref="System.Windows.Forms"/> Control.
|
||||
/// </summary>
|
||||
Desktop,
|
||||
|
||||
|
|
|
|||
|
|
@ -69,12 +69,12 @@ namespace Stride.Graphics
|
|||
SourceAlphaSaturate = 11,
|
||||
|
||||
/// <summary>
|
||||
/// The data source is the blend factor set with <see cref="GraphicsDevice.BlendStates"/>. No pre-blend operation.
|
||||
/// The data source is the blend factor set with <see cref="Stride.Graphics.BlendStates"/>. No pre-blend operation.
|
||||
/// </summary>
|
||||
BlendFactor = 14,
|
||||
|
||||
/// <summary>
|
||||
/// The data source is the blend factor set with <see cref="GraphicsDevice.SetBlendState"/>. The pre-blend operation inverts the blend factor, generating 1 - blend_factor.
|
||||
/// The data source is the blend factor set with <see cref="Stride.Graphics.BlendStates"/>. The pre-blend operation inverts the blend factor, generating 1 - blend_factor.
|
||||
/// </summary>
|
||||
InverseBlendFactor = 15,
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ namespace Stride.Graphics
|
|||
/// Creates a none buffer.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is equivalent to <see cref="BindFlags.None"/>.
|
||||
/// This is equivalent to <see cref="SharpDX.Direct3D11.BindFlags.None"/>.
|
||||
/// </remarks>
|
||||
None = 0,
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ using System;
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines the faces of a cube map for <see cref="TextureCube"/>.
|
||||
/// Defines the faces of a cube map for Cube <see cref="Texture"/>.
|
||||
/// </summary>
|
||||
public enum CubeMapFace
|
||||
{
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ namespace Stride.Graphics
|
|||
/// Indicates triangles facing a particular direction are not drawn.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This enumeration is part of a rasterizer-state object description (see <see cref="RasterizerState"/>).
|
||||
/// This enumeration is part of a rasterizer-state object description (see <see cref="RasterizerStates"/>).
|
||||
/// </remarks>
|
||||
[DataContract]
|
||||
public enum CullMode
|
||||
|
|
|
|||
|
|
@ -156,7 +156,8 @@ namespace Stride.Graphics.GeometricPrimitives
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// A geometric primitive. Use <see cref="Cube"/>, <see cref="Cylinder"/>, <see cref="GeoSphere"/>, <see cref="Plane"/>, <see cref="Sphere"/>, <see cref="Teapot"/>, <see cref="Torus"/>. See <see cref="Draw+vertices"/> to learn how to use it.
|
||||
/// A geometric primitive. Use <see cref="Cube"/>, <see cref="Cylinder"/>, <see cref="GeoSphere"/>, <see cref="Plane"/>, <see cref="Sphere"/>, <see cref="Teapot"/>, <see cref="Torus"/>.
|
||||
/// See <see href="https://doc.stride3d.net/latest/en/manual/graphics/low-level-api/draw-vertices.html">Draw vertices</see> to learn how to use it.
|
||||
/// </summary>
|
||||
public partial class GeometricPrimitive : GeometricPrimitive<VertexPositionNormalTexture>
|
||||
{
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ using Stride.Core.ReferenceCounting;
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// This class is a frontend to <see cref="SwapChain" /> and <see cref="SwapChain1" />.
|
||||
/// This class is a frontend to <see cref="SharpDX.DXGI.SwapChain" /> and <see cref="SharpDX.DXGI.SwapChain1" />.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// In order to create a new <see cref="GraphicsPresenter"/>, a <see cref="GraphicsDevice"/> should have been initialized first.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// Describes how the cpu is accessing a <see cref="GraphicsResource"/> with the <see cref="GraphicsDeviceContext.Map"/> method.
|
||||
/// Describes how the CPU is accessing a <see cref="GraphicsResource"/> with the <see cref="CommandList.MapSubresource"/> method.
|
||||
/// </summary>
|
||||
public enum MapMode
|
||||
{
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// A GPU resource mapped for CPU access. This is returned by using <see cref="GraphicsDevice.MapSubresource"/>
|
||||
/// A GPU resource mapped for CPU access. This is returned by using <see cref="CommandList.MapSubresource"/>
|
||||
/// </summary>
|
||||
public partial struct MappedResource
|
||||
{
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ using Stride.Rendering;
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the <see cref="GraphicsDevice.DrawQuad"/> method.
|
||||
/// Primitive quad use to draw an effect on a quad (fullscreen by default). This is directly accessible from the <see cref="GraphicsDeviceExtensions.DrawQuad"/> method.
|
||||
/// </summary>
|
||||
public class PrimitiveQuad : ComponentBase
|
||||
{
|
||||
|
|
|
|||
|
|
@ -192,7 +192,7 @@ namespace Stride.Graphics.SDL
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show window. The first time a window is shown we execute any actions from <see cref="HandleCreated"/>.
|
||||
/// Show window. The first time a window is shown we execute any actions from 'HandleCreated' />.
|
||||
/// </summary>
|
||||
public void Show()
|
||||
{
|
||||
|
|
@ -358,7 +358,7 @@ namespace Stride.Graphics.SDL
|
|||
// FIXME: We need to adapt the ClientSize to an actual Size to take into account borders.
|
||||
// FIXME: On Windows you do this by using AdjustWindowRect.
|
||||
// SDL.SDL_GetWindowBordersSize(sdlHandle, out var top, out var left, out var bottom, out var right);
|
||||
// From SDL documentaion: Use this function to set the size of a window's client area.
|
||||
// From SDL documentation: Use this function to set the size of a window's client area.
|
||||
SDL.SetWindowSize(sdlHandle, value.Width, value.Height);
|
||||
}
|
||||
}
|
||||
|
|
@ -381,7 +381,7 @@ namespace Stride.Graphics.SDL
|
|||
}
|
||||
set
|
||||
{
|
||||
// From SDL documentaion: Use this function to set the size of a window's client area.
|
||||
// From SDL documentation: Use this function to set the size of a window's client area.
|
||||
SDL.SetWindowSize(sdlHandle, value.Width, value.Height);
|
||||
SDL.SetWindowPosition(sdlHandle, value.X, value.Y);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -20,8 +20,8 @@ namespace Stride.Graphics
|
|||
/// <param name="rotation">The rotation to apply on the sprite</param>
|
||||
/// <param name="depthLayer">The depth layer to which draw the sprite</param>
|
||||
/// <param name="spriteEffects">The sprite effect to apply on the sprite</param>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin(Stride.Graphics.SpriteSortMode,Stride.Graphics.Effect)"/>
|
||||
/// and <see cref="SpriteBatch.End()"/> calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin"/>
|
||||
/// and `SpriteBatch.End()` calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <exception cref="ArgumentException">The provided frame index is not valid.</exception>
|
||||
/// <exception cref="ArgumentOutOfRangeException">The provided spriteBatch is null</exception>
|
||||
public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, float rotation = 0, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None)
|
||||
|
|
@ -40,8 +40,8 @@ namespace Stride.Graphics
|
|||
/// <param name="scales">The scale factors to apply on the sprite</param>
|
||||
/// <param name="depthLayer">The depth layer to which draw the sprite</param>
|
||||
/// <param name="spriteEffects">The sprite effect to apply on the sprite</param>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin(Stride.Graphics.SpriteSortMode,Stride.Graphics.Effect)"/>
|
||||
/// and <see cref="SpriteBatch.End()"/> calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin"/>
|
||||
/// and `SpriteBatch.End()` calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <exception cref="ArgumentException">The provided frame index is not valid.</exception>
|
||||
/// <exception cref="ArgumentOutOfRangeException">The provided spriteBatch is null</exception>
|
||||
public static void Draw(this Sprite sprite, SpriteBatch spriteBatch, Vector2 position, Color color, Vector2 scales, float rotation = 0f, float depthLayer = 0, SpriteEffects spriteEffects = SpriteEffects.None)
|
||||
|
|
@ -61,8 +61,8 @@ namespace Stride.Graphics
|
|||
/// <param name="spriteBatch">The sprite batch used to draw the sprite.</param>
|
||||
/// <param name="worldMatrix">The world matrix of the sprite</param>
|
||||
/// <param name="color">The color to apply on the sprite</param>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin(Stride.Graphics.SpriteSortMode,Stride.Graphics.Effect)"/>
|
||||
/// and <see cref="SpriteBatch.End()"/> calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <remarks>This function must be called between the <see cref="SpriteBatch.Begin"/>
|
||||
/// and `SpriteBatch.End()` calls of the provided <paramref name="spriteBatch"/></remarks>
|
||||
/// <exception cref="ArgumentException">The provided frame index is not valid.</exception>
|
||||
/// <exception cref="ArgumentOutOfRangeException">The provided spriteBatch is null</exception>
|
||||
public static void Draw3D(this Sprite sprite, Sprite3DBatch spriteBatch, ref Matrix worldMatrix, ref Color4 color)
|
||||
|
|
|
|||
|
|
@ -86,7 +86,7 @@ namespace Stride.Graphics
|
|||
/// <dd> <p>Structure that specifies multisampling parameters for the texture. See <strong><see cref="SharpDX.DXGI.SampleDescription"/></strong>.</p> </dd>
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This field is only valid for <see cref="Texture2D"/>.
|
||||
/// This field is only valid for <see cref="TextureDimension.Texture2D"/>.
|
||||
/// </remarks>
|
||||
public MultisampleCount MultisampleCount;
|
||||
|
||||
|
|
|
|||
|
|
@ -33,12 +33,12 @@ using Half = Stride.Core.Mathematics.Half;
|
|||
namespace Stride.Graphics
|
||||
{
|
||||
/// <summary>
|
||||
/// A description of a single element for the input-assembler stage. This structure is related to <see cref="Direct3D11.InputElement"/>.
|
||||
/// A description of a single element for the input-assembler stage. This structure is related to <see cref="SharpDX.Direct3D11.InputElement"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Because <see cref="Direct3D11.InputElement"/> requires to have the same <see cref="VertexBufferLayout.SlotIndex"/>, <see cref="VertexBufferLayout.VertexClassification"/> and <see cref="VertexBufferLayout.instanceDataStepRate"/>,
|
||||
/// Because <see cref="SharpDX.Direct3D11.InputElement"/> requires to have the same <see cref="VertexBufferLayout.SlotIndex"/>, <see cref="VertexBufferLayout.VertexClassification"/> and <see cref="VertexBufferLayout.instanceDataStepRate"/>,
|
||||
/// the <see cref="VertexBufferLayout"/> structure encapsulates a set of <see cref="VertexElement"/> for a particular slot, classification and instance data step rate.
|
||||
/// Unlike the default <see cref="Direct3D11.InputElement"/>, this structure accepts a semantic name with a postfix number that will be automatically extracted to the semantic index.
|
||||
/// Unlike the default <see cref="SharpDX.Direct3D11.InputElement"/>, this structure accepts a semantic name with a postfix number that will be automatically extracted to the semantic index.
|
||||
/// </remarks>
|
||||
/// <seealso cref="VertexBufferLayout"/>
|
||||
[DataContract]
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ namespace Stride.Input
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Processes a <see cref="InputEvent"/>, converting it to a <see cref="PointerEvent"/>. Also calls <see cref="OnPointer"/> and updates <see cref="CurrentPointerEvents"/>
|
||||
/// Processes a <see cref="InputEvent"/>, converting it to a <see cref="PointerEvent"/>. Also calls <see cref="UpdatePointerState"/> and updates current <see cref="PointerEvent"/>
|
||||
/// </summary>
|
||||
/// <param name="evt"></param>
|
||||
public PointerEvent ProcessPointerEvent(InputEvent evt)
|
||||
|
|
@ -85,7 +85,7 @@ namespace Stride.Input
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Updates a pointer event with position / type / id set and updates the storted pointer data
|
||||
/// Updates a pointer event with position / type / id set and updates the stored pointer data
|
||||
/// </summary>
|
||||
/// <param name="evt"></param>
|
||||
public void UpdatePointerState(PointerEvent evt, bool updateDelta = true)
|
||||
|
|
@ -129,7 +129,7 @@ namespace Stride.Input
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Retrueves a pointer data structure unqiue to the given pointer ID
|
||||
/// Retrieves a pointer data structure unique to the given pointer ID
|
||||
/// </summary>
|
||||
/// <param name="pointerId"></param>
|
||||
/// <returns></returns>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ using Stride.Core.Annotations;
|
|||
namespace Stride.Rendering.Compositing
|
||||
{
|
||||
/// <summary>
|
||||
/// Describes the code part of a <see cref="GraphicsCompositor"/>.
|
||||
/// Describes the code part of a `GraphicsCompositor`.
|
||||
/// </summary>
|
||||
[DataContract(Inherited = true)]
|
||||
public abstract class SceneRendererBase : RendererCoreBase, ISceneRenderer
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ namespace Stride.Rendering
|
|||
{
|
||||
/// <summary>
|
||||
/// A collection of <see cref="IGraphicsRenderer"/> that is itself a <see cref="IGraphicsRenderer"/> handling automatically
|
||||
/// <see cref="IGraphicsRenderer.Initialize"/> and <see cref="IGraphicsRenderer.Unload"/>.
|
||||
/// <see cref="IGraphicsRendererCore.Initialize"/> and <see cref="RendererCoreBase.Unload"/>.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">Type of the <see cref="IGraphicsRenderer"/></typeparam>.
|
||||
[DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)]
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ namespace Stride.Rendering
|
|||
{
|
||||
/// <summary>
|
||||
/// A collection of <see cref="IGraphicsRenderer"/> that is itself a <see cref="IGraphicsRenderer"/> handling automatically
|
||||
/// <see cref="IGraphicsRenderer.Initialize"/> and <see cref="IGraphicsRenderer.Unload"/>.
|
||||
/// <see cref="IGraphicsRendererCore.Initialize"/> and <see cref="RendererCoreBase.Unload"/>.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">Type of the <see cref="IGraphicsRenderer"/></typeparam>.
|
||||
[DataSerializer(typeof(ListAllSerializer<,>), Mode = DataSerializerGenericMode.TypeAndGenericArguments)]
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ namespace Stride.Rendering.Images
|
|||
/// <param name="context">The context.</param>
|
||||
/// <param name="name">The name.</param>
|
||||
/// <exception cref="System.ArgumentNullException">context</exception>
|
||||
protected ImageEffect(RenderContext context, string name = null)
|
||||
protected ImageEffect(RenderContext context, string name = null)
|
||||
: this(name)
|
||||
{
|
||||
Initialize(context);
|
||||
|
|
@ -169,7 +169,7 @@ namespace Stride.Rendering.Images
|
|||
/// Binds a set of viewports to the rasterizer stage.
|
||||
/// </summary>
|
||||
/// <param name="values">The set of viewports to bind.</param>
|
||||
/// <remarks>Only <see cref="CommandList.MaxViewportAndScissorRectangleCount"/> scissors can be used simultaneously</remarks>
|
||||
/// <remarks>Only <see cref="CommandList"/>'s `MaxViewportAndScissorRectangleCount` scissors can be used simultaneously</remarks>
|
||||
public void SetViewports(ReadOnlySpan<Viewport> values)
|
||||
{
|
||||
if (values.Length > CommandList.MaxViewportAndScissorRectangleCount)
|
||||
|
|
@ -202,7 +202,7 @@ namespace Stride.Rendering.Images
|
|||
/// Binds a set of scissor rectangles to the rasterizer stage.
|
||||
/// </summary>
|
||||
/// <param name="values">The set of scissor rectangles to bind.</param>
|
||||
/// <remarks>Only <see cref="CommandList.MaxViewportAndScissorRectangleCount"/> viewports can be used simultaneously</remarks>
|
||||
/// <remarks>Only <see cref="CommandList"/>'s `MaxViewportAndScissorRectangleCount` viewports can be used simultaneously</remarks>
|
||||
public void SetScissorRectangles(ReadOnlySpan<Rectangle> values)
|
||||
{
|
||||
if (values.Length > CommandList.MaxViewportAndScissorRectangleCount)
|
||||
|
|
@ -415,7 +415,7 @@ namespace Stride.Rendering.Images
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="DrawEffect.DrawCore"/>.
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="RendererBase.DrawCore"/>.
|
||||
/// </summary>
|
||||
/// <returns>A new instance of texture.</returns>
|
||||
protected Texture NewScopedRenderTarget2D(TextureDescription description)
|
||||
|
|
@ -426,7 +426,7 @@ namespace Stride.Rendering.Images
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a render target output for the specified description with a single mipmap, scoped for the duration of the <see cref="DrawEffect.DrawCore"/>.
|
||||
/// Gets a render target output for the specified description with a single mipmap, scoped for the duration of the <see cref="RendererBase.DrawCore"/>.
|
||||
/// </summary>
|
||||
/// <param name="width">The width.</param>
|
||||
/// <param name="height">The height.</param>
|
||||
|
|
@ -444,7 +444,7 @@ namespace Stride.Rendering.Images
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a render target output for the specified description, scoped for the duration of the <see cref="DrawEffect.DrawCore"/>.
|
||||
/// Gets a render target output for the specified description, scoped for the duration of the <see cref="RendererBase.DrawCore"/>.
|
||||
/// </summary>
|
||||
/// <param name="width">The width.</param>
|
||||
/// <param name="height">The height.</param>
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ namespace Stride.Rendering.Images
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Sets the default parameters (called at constructor time and if <see cref="Reset"/> is called)
|
||||
/// Sets the default parameters (called at constructor time and if <see cref="ImageEffect.Reset"/> is called)
|
||||
/// </summary>
|
||||
protected override void SetDefaultParameters()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ namespace Stride.Rendering.Lights
|
|||
public class ForwardLightingRenderFeature : SubRenderFeature
|
||||
{
|
||||
/// <summary>
|
||||
/// Property key to access the current collection of <see cref="CameraComponent"/> from <see cref="RenderContext.Tags"/>.
|
||||
/// Property key to access the current collection of `CameraComponent` from <see cref="ComponentBase.Tags"/>.
|
||||
/// </summary>
|
||||
public static readonly PropertyKey<RenderLightCollection> CurrentLights = new PropertyKey<RenderLightCollection>("ForwardLightingRenderFeature.CurrentLights", typeof(ForwardLightingRenderFeature));
|
||||
|
||||
|
|
|
|||
|
|
@ -88,7 +88,7 @@ namespace Stride.Rendering.Lights
|
|||
public sealed class PartitionManual : PartitionModeBase
|
||||
{
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="LightDirectionalManualPartitionMode"/> class.
|
||||
/// Initializes a new instance of the <see cref="PartitionManual"/> class.
|
||||
/// </summary>
|
||||
public PartitionManual()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ using Stride.Rendering.Skyboxes;
|
|||
namespace Stride.Rendering.Lights
|
||||
{
|
||||
/// <summary>
|
||||
/// A light coming from a skybox. The <see cref="SkyboxComponent"/> must be set on the entity in order to see a skybox.
|
||||
/// A light coming from a skybox. The `BackgroundComponent` must be set on the entity in order to see a skybox.
|
||||
/// </summary>
|
||||
[DataContract("LightSkybox")]
|
||||
[Display("Skybox")]
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ using Stride.Graphics;
|
|||
namespace Stride.Rendering
|
||||
{
|
||||
/// <summary>
|
||||
/// Instantiation of an Effect for a given <see cref="StaticEffectObjectNodeReference"/>.
|
||||
/// Instantiation of an Effect for a given <see cref="EffectObjectNodeReference"/>.
|
||||
/// </summary>
|
||||
public class RenderEffect
|
||||
{
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ namespace Stride.Rendering
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether this <see cref="EntityComponentRendererBase"/> is enabled.
|
||||
/// Gets or sets a value indicating whether this <see cref="RendererCoreBase"/> is enabled.
|
||||
/// </summary>
|
||||
/// <value><c>true</c> if enabled; otherwise, <c>false</c>.</value>
|
||||
/// <userdoc>Enabled if checked, disabled otherwise</userdoc>
|
||||
|
|
@ -151,7 +151,7 @@ namespace Stride.Rendering
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="DrawEffect.DrawCore"/>.
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="DrawEffect.Draw"/>.
|
||||
/// </summary>
|
||||
/// <param name="description">The description of the buffer to allocate</param>
|
||||
/// <param name="viewFormat">The pixel format seen in shader</param>
|
||||
|
|
@ -163,7 +163,7 @@ namespace Stride.Rendering
|
|||
}
|
||||
|
||||
/// <summary>
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="DrawEffect.DrawCore"/>.
|
||||
/// Gets a render target with the specified description, scoped for the duration of the <see cref="DrawEffect.Draw"/>.
|
||||
/// </summary>
|
||||
/// <returns>A new instance of texture.</returns>
|
||||
protected Buffer NewScopedTypedBuffer(int count, PixelFormat viewFormat, bool isUnorderedAccess, GraphicsResourceUsage usage = GraphicsResourceUsage.Default)
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче