feat: Add Opacity to window api

[Arc-huangjingtong]

PR Details

Add BackgroundColor and Opacity API

Why ADD

Support games like https://store.steampowered.com/app/2666510/Rustys_Retirement/

Related Issue

Types of changes

• Docs change / refactoring / dependency upgrade
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My change requires a change to the documentation.
• I have added tests to cover my changes.
• All new and existing tests passed.
• I have built and run the editor to try this change out.

[Eideren]

Looks cool, set it to draft for now given the WIP in the title, feel free to change it back to ready for review when you're ready :)

[Arc-huangjingtong]

Now,set opacity prop.in the winform window and SDL window ,is OK

[VaclavElias]

XML comment improments 🙂.

/// <summary>
/// Gets or sets the opacity of the window.
/// </summary>
/// <value>1.0d is fully opaque, 0.0d is fully transparent. The value will automatically be clamped to [0.0d, 1.0d].</value>
/// <remarks>The default value, if the window is null, is considered fully opaque (1.0d).</remarks>

[VaclavElias]

Some spacing corrections

/// <summary>
/// Gets or sets the background color of the window.
/// </summary>
/// <value>The background color.</value>

[Arc-huangjingtong]

Regarding the function of opacity, it seems to be working well, and then the function of designing window transparency. Unfortunately, I have to start working and will continue to develop it next weekend. :)

[Arc-huangjingtong]

I'm research how to make Stride support transparent backgrounds, the backgroundColor is same as SplashScreenColor in GameSettingsAsset.
SO, that API(backgroundColor) ,will remove.

The following is my progress.....

if we change form.backColor or SplashScreenColorwith alpha , the backgroundcolor in screen will not change ,

and we set
drawContext.CommandList.Clear(drawContext.CommandList.RenderTarget,new Color4(1, 1, 0, 0));
in project jumpyJet , the scrren background color will be yellow

After several hours of research, I find the key point....

If we want to support transparet, we should change code in file SwapChainGraphicsPresenter.Direct3D line 460,

var description = new SwapChainDescription
{
     ModeDescription = new ModeDescription(Description.BackBufferWidth, Description.BackBufferHeight, 
Description.RefreshRate.ToSharpDX(), (DXGI_Format)swapchainFormat)
     , BufferCount     = bufferCount
     , // TODO: Do we really need this to be configurable by the user?
     OutputHandle      = handle
     , SampleDescription = new SampleDescription((int)Description.MultisampleCount, 0)
     , SwapEffect        = useFlipModel ? SwapEffect.FlipDiscard : SwapEffect.Discard
     , Usage             = Usage.BackBuffer | Usage.RenderTargetOutput
     , IsWindowed        = true
     , Flags             = GetSwapChainFlags()
     ,
};

SwapChainDescription is not support alphamode , if we want ,we should replace it by SwapChainDescription1

These modifications will bring about significant changes. Perhaps we should have a more detailed discussion

[Arc-huangjingtong]

Now , I delete the "BackgroundColor" API , it will change in other PR :)

[Eideren]

Looks good, anything else to add @Kryptos-FR ?

[VaclavElias]

I could review only XML comments. They seem to be ok now. Thanks.

[Arc-huangjingtong]

I could review only XML comments. They seem to be ok now. Thanks.

Do I need to submit changes to the API document? :)

[VaclavElias]

The API docs https://doc.stride3d.net/latest/en/api/index.html are generated automatically from the XML comments you added. Once we release new Stride NuGet packages, usually a few days after we deploy Stride Docs https://github.com/stride3d/stride-docs. We use docfx which is a static generator https://doc.stride3d.net/latest/en/contributors/documentation/index.html.

So you don't need to do anything regarding API docs.

If you would like to update the manual https://doc.stride3d.net/latest/en/manual/index.html, then a PR can be made here https://github.com/stride3d/stride-docs for the page updated or added. In this case I don't think we have any Window manual there.

[Arc-huangjingtong]

The API docs https://doc.stride3d.net/latest/en/api/index.html are generated automatically from the XML comments you added. Once we release new Stride NuGet packages, usually a few days after we deploy Stride Docs https://github.com/stride3d/stride-docs. We use docfx which is a static generator https://doc.stride3d.net/latest/en/contributors/documentation/index.html.

So you don't need to do anything regarding API docs.

If you would like to update the manual https://doc.stride3d.net/latest/en/manual/index.html, then a PR can be made here https://github.com/stride3d/stride-docs for the page updated or added. In this case I don't think we have any Window manual there.

Thank you, I think I am more familiar with this process now! 😄