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] GraphicsCompositor - Add XML summary #2306

Closed
VaclavElias opened this issue Jun 4, 2024 · 3 comments · Fixed by #2436
Closed

[Docs] GraphicsCompositor - Add XML summary #2306

VaclavElias opened this issue Jun 4, 2024 · 3 comments · Fixed by #2436
Assignees
Labels
area-Doc Issues related to documentation and XML comments

Comments

@VaclavElias
Copy link
Contributor

Describe the update or improvement you would like to see
I would like to add a description summary to GraphicsCompositor, what is it doing and a link to our Stride docs.

Is this related to a specific part of the documentation?
https://doc.stride3d.net/latest/en/manual/graphics/graphics-compositor/index.html

Why is this update needed?
I am going through the basics and architecture of Stride and when we work with GraphicsCompositor, the IntelliSense should provide some basis description.

Additional context
Proposed text, also below in xml.

image

Proposed changes
I would like to review this addition:

    /// <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>Modifying the compositor 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>
@VaclavElias VaclavElias added the area-Doc Issues related to documentation and XML comments label Jun 4, 2024
@VaclavElias
Copy link
Contributor Author

Are you ok with this summary? If yes, I will make a PR.

@Eideren
Copy link
Collaborator

Eideren commented Sep 2, 2024

Key features of the GraphicsCompositor include:
[...]
Modifying the compositor from scripts

Maybe "Editable in the gamestudio and at runtime from scripts" instead ?
Otherwise looks good !

@VaclavElias
Copy link
Contributor Author

Thanks. I will make the updates and then PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Doc Issues related to documentation and XML comments
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants