Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Added xml comment, and placed the namespace to correct position… #2436

Merged
merged 1 commit into from
Sep 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,37 @@
using Stride.Core;
using Stride.Core.Annotations;
using Stride.Core.Collections;
using Stride.Core.Diagnostics;
using Stride.Core.Serialization;
using Stride.Core.Serialization.Contents;
using Stride.Core.Diagnostics;
using Stride.Engine;
using Stride.Graphics;

namespace Stride.Rendering.Compositing
{
/// <summary>
/// The <c>GraphicsCompositor</c> class organizes how scenes are rendered in the Stride engine, providing extensive customization of the rendering pipeline.
/// </summary>
/// <remarks>
/// This class handles the initialization and destruction of the render system, manages the cameras used in the composition, and controls the render stages and features.
/// It provides entry points for the game compositor, a single view compositor, and a compositor used by the scene editor.
/// <para>
/// Key features of the <c>GraphicsCompositor</c> include:
/// </para>
/// <list type="bullet">
/// <item><description>Using one or multiple cameras</description></item>
/// <item><description>Filtering entities</description></item>
/// <item><description>Rendering to one or more render textures with different viewports</description></item>
/// <item><description>Setting HDR or LDR rendering</description></item>
/// <item><description>Applying post effects to a render target</description></item>
/// <item><description>Clearing a render target or only the depth buffer</description></item>
/// <item><description>Editable in the Game Studio and at runtime from scripts</description></item>
/// </list>
/// <para>
/// For more information, see the
/// <see href="https://doc.stride3d.net/latest/en/manual/graphics/graphics-compositor/index.html">Graphics Compositor</see> documentation.
/// </para>
/// </remarks>
[DataSerializerGlobal(typeof(ReferenceSerializer<GraphicsCompositor>), Profile = "Content")]
[ReferenceSerializer, ContentSerializer(typeof(DataContentSerializerWithReuse<GraphicsCompositor>))]
[DataContract]
Expand Down