Merge remote-tracking branch 'upstream/master'

en/manual/graphics/effects-and-shaders/custom-shaders.md

@@ -55,7 +55,7 @@ You can also use custom shaders to create custom post effects. For more informat
 
     >[!Note]
     >To be accessible from the Game Studio Property Grid, the shader must inherit from `ComputeColor`.
-    >As '`ComputeColor` always returns a float4 value, properties that take float values (eg metalness and gloss maps) use the first component (the red component) of the value returned by `ComputeColor`. 
+    >As `ComputeColor` always returns a float4 value, properties that take float values (eg metalness and gloss maps) use the first component (the red component) of the value returned by `ComputeColor`. 
 
 7. Save all the files in the solution (**File > Save All**).
 
@@ -127,11 +127,11 @@ For example, the code below defines and uses the dynamic parameter `Frequency`:
 ```cs
 shader ComputeColorWave: ComputeColor, Texturing
 {
-	cbuffer PerMaterial
-	{
-		stage float Frequency = 1.0f;
-	}
-	
+    cbuffer PerMaterial
+    {
+        stage float Frequency = 1.0f;
+    }
+
     override float4 Compute()
     {
         return sin(( Global.Time ) * 2 * 3.14 * Frequency);

en/manual/graphics/low-level-api/pipeline-state.md

@@ -31,8 +31,8 @@ The @'Stride.Graphics.MutablePipelineState' class let you set states independent
 var mutablePipelineState = new MutablePipelineState();
 
 // Setting values and rebuilding
-mutablePipelineState.State.BlendState = BlendStates.AlphaBlend
-mutablePipelineState.Update
+mutablePipelineState.State.BlendState = BlendStates.AlphaBlend;
+mutablePipelineState.Update();
  
 // Applying the state to the pipeline
 CommandList.SetPipelineState(mutablePipelineState.CurrentState);
@@ -176,7 +176,7 @@ The [Draw vertices](draw-vertices.md) page describes how to create custom vertex
 **Code:** Set an input layout
 
 ```cs
-VertexDeclaration vertexDeclaration = ...
+VertexDeclaration vertexDeclaration = new VertexDeclaration();
 pipelineStateDescription.InputElements = vertexDeclaration.CreateInputElements();
 pipelineStateDescription.PrimitiveType = PrimitiveType.TriangleStrip;
 ```

en/manual/graphics/low-level-api/spritebatch.md

@@ -48,12 +48,12 @@ spriteBatch.End();
 There are five modes to draw a sprite batch. They are enumerated in the @'Stride.Graphics.SpriteSortMode' enum:
 
 - Deferred (default mode): the sprites are drawn at the same time at the end to reduce the drawcall overhead
-- Immediate: the sprites are drawn after each @'Stride.Graphics.SpriteBatch.Draw' call
+- Immediate: the sprites are drawn after each @'Stride.Graphics.SpriteBatch.Draw*' call
 - Texture: Deferred mode but sprites are sorted based on their texture to reduce effect parameters update
 - BackToFront: Deferred mode with a sort based on the z-order of the sprites
 - FrontToBack: Deferred mode with a sort based on the z-order of the sprites
 
-To set the mode, specify it in the @'Stride.Graphics.SpriteBatch.Begin' method.
+To set the mode, specify it in the @'Stride.Graphics.SpriteBatch.Begin*' method.
 
 **Code:** Deferred drawing of the sprite batch
 

en/manual/graphics/low-level-api/spritefont.md

@@ -10,7 +10,7 @@ The @'Stride.Graphics.SpriteFont' class is a convenient way to draw text. It wor
 
 ## Load a spriteFont
 
-After a font asset is compiled it can be loaded as a @'Stride.Graphics.SpriteFont' instance using the @'Stride.Core.Serialization.Assets.ContentManager'. It contains all the options to display a text (bitmaps, kerning, line spacing etc).
+After a font asset is compiled it can be loaded as a @'Stride.Graphics.SpriteFont' instance using the @'Stride.Core.Serialization.Contents.ContentManager'. It contains all the options to display a text (bitmaps, kerning, line spacing etc).
 
 **Code:** Load a SpriteFont
 
@@ -20,7 +20,7 @@ var myFont = Content.Load<SpriteFont>("MyFont");
 
 ## Write text on screen
 
-Once the font is loaded, you can display any text with a @'Stride.Graphics.SpriteBatch'. The @'Stride.Graphics.SpriteBatch.DrawString' method performs the draw. For more information about the SpriteBatch, see the [SpriteBatch](spritebatch.md) page.
+Once the font is loaded, you can display any text with a @'Stride.Graphics.SpriteBatch'. The @'Stride.Graphics.SpriteBatch.DrawString*' method performs the draw. For more information about the SpriteBatch, see the [SpriteBatch](spritebatch.md) page.
 
 **Code:** Write text
 

en/manual/graphics/low-level-api/textures-and-render-textures.md

@@ -51,7 +51,7 @@ var myDepthBuffer = Texture.New2D(GraphicsDevice, 512, 512, false, PixelFormat.D
 
 ### Use a render target
 
-Once these buffers are created, you can can easily set them as current render textures.
+Once these buffers are created, you can easily set them as current render textures.
 
 ### Code: Use a render target
 

en/manual/graphics/sprite-fonts.md

@@ -122,7 +122,7 @@ Do **not** use SDF fonts when:
 | Property                    | Description  
 |-----------------------------|--------------
 | Font Source                 | System (installed on this machine) or from file. The system fonts can also choose **Bold** and *Italic* options.
-| Font Type                   | Offline Rasterized    
+| Font Type                   | Signed Distance Field
 | Size (in pixels)            | The font will be baked with this size. All font sizes can still be displayed. Bigger size usually results in better quality, and generally you want to keep this at 20 or more to avoid visual glitches. 
 | Character set               | (Optional) A text file containing all characters which need to be baked.   
 | Character regions           | Code for regions of characters which need to be baked. For example (32 - 127) is a region sufficient for ASCII character sets. 

en/manual/toc.yml

@@ -570,6 +570,8 @@ items:
         href: troubleshooting/debug-text.md
       - name: Profiling
         href: troubleshooting/profiling.md
+      - name: Unit Tests
+        href: troubleshooting/unit-tests.md
       - name: Stride doesn't run
         href: troubleshooting/stride-doesnt-run.md
       - name: Default value changes ignored at runtime

en/manual/troubleshooting/index.md

@@ -7,6 +7,7 @@ These pages describe how to fix problems with Stride.
 * [Logging](logging.md)
 * [Debug text](debug-text.md)
 * [Profiling](profiling.md)
+* [Unit Tests](unit-tests.md)
 * [Stride doesn't run](stride-doesnt-run.md)
 * [Default value changes ignored at runtime](default-value-changes-ignored-at-runtime.md)
 * [Lights don't cast shadows](lights-dont-cast-shadows.md)

en/manual/troubleshooting/unit-tests.md

@@ -0,0 +1,89 @@
+# Unit Tests
+Unit tests in Stride are set up like any other unit tests in dotnet, 
+you create a new project specifically for unit tests, then write your tests in different C# files.
+
+Here's a bare-bone project to get you started:
+`YOUR_PROJECT_NAME.Windows.Tests.csproj`
+```xml
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <!-- Change this framework to match the one specified in your *.Windows.csproj -->
+        <TargetFramework>net8.0-windows</TargetFramework>
+        <RuntimeIdentifier>win-x64</RuntimeIdentifier>
+        <OutputType>WinExe</OutputType>
+
+        <OutputPath>..\Bin\Tests\Windows\$(Configuration)\</OutputPath>
+        <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+
+        <!-- Force msbuild to check to rebuild this assembly instead of letting VS IDE guess -->
+        <DisableFastUpToDateCheck>true</DisableFastUpToDateCheck>
+        
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+
+        <IsPackable>false</IsPackable>
+        <IsTestProject>true</IsTestProject>
+    </PropertyGroup>
+    <ItemGroup>
+        <!-- Add a reference to your game project here, do not reference the windows project here -->
+        <PackageReference Include="coverlet.collector" Version="6.0.0"/>
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
+        <PackageReference Include="xunit" Version="2.5.3"/>
+        <PackageReference Include="xunit.runner.visualstudio" Version="2.5.3"/>
+    </ItemGroup>
+    <ItemGroup>
+        <Using Include="Xunit"/>
+    </ItemGroup>
+</Project>
+```
+And an example C# file:
+```cs
+using Stride.Engine;
+
+public class Tests
+{
+    [Fact]
+    public void MyBareboneTest()
+    {
+        Assert.NotEqual(1, 2);
+    }
+    
+    [Fact]
+    public void MyGameTest()
+    {
+        RunGameTest(async (game, scene) =>
+        {
+            var myEntity = new Entity();
+            scene.Entities.Add(myEntity);
+
+            Assert.NotEmpty(scene.Entities);
+
+            await game.Script.NextFrame(); // Wait one frame if you need to
+
+            myEntity.Scene = null;
+
+            Assert.Empty(scene.Entities);
+        });
+    }
+
+    /// <summary>
+    /// Run the given function within a game, providing support for tests requiring ECS, physics simulation, graphics and others.
+    /// </summary>
+    private static void RunGameTest(Func<Game, Scene, Task> asyncFunction)
+    {
+        using var game = new Game();
+        
+        // Fixed time step to reduce framerate discrepancies
+        game.IsFixedTimeStep = true;
+        game.IsDrawDesynchronized = false;
+        game.TargetElapsedTime = TimeSpan.FromTicks(10000000 / 60); // 60hz, 60fps
+        
+        game.Script.AddTask(async () =>
+        {
+            await asyncFunction(game, game.SceneSystem.SceneInstance.RootScene);
+            game.Exit();
+        });
+        game.Run();
+    }
+}
+```

jp/manual/graphics/effects-and-shaders/custom-shaders.md

@@ -265,11 +265,11 @@ For example, the code below defines and uses the dynamic parameter `Frequency`:
 ```cs
 shader ComputeColorWave: ComputeColor, Texturing
 {
-	cbuffer PerMaterial
-	{
-		stage float Frequency = 1.0f;
-	}
-	
+    cbuffer PerMaterial
+    {
+        stage float Frequency = 1.0f;
+    }
+
     override float4 Compute()
     {
         return sin(( Global.Time ) * 2 * 3.14 * Frequency);

jp/manual/graphics/low-level-api/pipeline-state.md

@@ -62,8 +62,8 @@ var mutablePipelineState = new MutablePipelineState();
 
 // 値を設定して再構築
 // Setting values and rebuilding
-mutablePipelineState.State.BlendState = BlendStates.AlphaBlend
-mutablePipelineState.Update
+mutablePipelineState.State.BlendState = BlendStates.AlphaBlend;
+mutablePipelineState.Update();
  
 // ステートをパイプラインに適用
 // Applying the state to the pipeline
@@ -317,7 +317,7 @@ The [Draw vertices](draw-vertices.md) page describes how to create custom vertex
 -->
 
 ```cs
-VertexDeclaration vertexDeclaration = ...
+VertexDeclaration vertexDeclaration = new VertexDeclaration();
 pipelineStateDescription.InputElements = vertexDeclaration.CreateInputElements();
 pipelineStateDescription.PrimitiveType = PrimitiveType.TriangleStrip;
 ```

jp/manual/graphics/low-level-api/spritebatch.md

@@ -95,22 +95,22 @@ There are five modes to draw a sprite batch. They are enumerated in the @'Stride
 -->
 
 - Deferred（既定）: スプライトは最後にまとめて描画されます。描画呼び出しのオーバーヘッドが削減されます。
-- Immediate: @'Stride.Graphics.SpriteBatch.Draw' を呼び出すたびに、すぐにスプライトが描画されます。
+- Immediate: @'Stride.Graphics.SpriteBatch.Draw*' を呼び出すたびに、すぐにスプライトが描画されます。
 - Texture: Deffered モードですが、エフェクトパラメータの更新を減らすために、スプライトはテクスチャーに基づいてソートされます。
 - BackToFront: スプライトの Z オーダーに基づいてソートを行う Deferred モードです。
 - FrontToBack: スプライトの Z オーダーに基づいてソートを行う Deferred モードです。
 
 <!--
 - Deferred (default mode): the sprites are drawn at the same time at the end to reduce the drawcall overhead
-- Immediate: the sprites are draw after each each @'Stride.Graphics.SpriteBatch.Draw' call
+- Immediate: the sprites are draw after each each @'Stride.Graphics.SpriteBatch.Draw*' call
 - Texture: Deferred mode but sprites are sorted based on their texture to reduce effect parameters update
 - BackToFront: Deferred mode with a sort based on the z-order of the sprites
 - FrontToBack: Deferred mode with a sort based on the z-order of the sprites
 -->
 
-モードは、@'Stride.Graphics.SpriteBatch.Begin' メソッドで指定します。
+モードは、@'Stride.Graphics.SpriteBatch.Begin*' メソッドで指定します。
 <!--
-To set the mode, specify it in the @'Stride.Graphics.SpriteBatch.Begin' method.
+To set the mode, specify it in the @'Stride.Graphics.SpriteBatch.Begin*' method.
 -->
 
 **コード：** スプライトバッチの遅延描画

jp/manual/graphics/low-level-api/spritefont.md

@@ -28,9 +28,9 @@ The @'Stride.Graphics.SpriteFont' class is a convenient way to draw text. It wor
 ## Load a spriteFont
 -->
 
-フォントアセットをコンパイルした後は、@'Stride.Core.Serialization.Assets.ContentManager' を使って、@'Stride.Graphics.SpriteFont' インスタンスとして読み込むことができます。これは、テキストを表示するためのすべてのオプション（ビットマップ、[カーニング](https://ja.wikipedia.org/wiki/%E3%82%AB%E3%83%BC%E3%83%8B%E3%83%B3%E3%82%B0)、行間など）を含んでいます。
+フォントアセットをコンパイルした後は、@'Stride.Core.Serialization.Contents.ContentManager' を使って、@'Stride.Graphics.SpriteFont' インスタンスとして読み込むことができます。これは、テキストを表示するためのすべてのオプション（ビットマップ、[カーニング](https://ja.wikipedia.org/wiki/%E3%82%AB%E3%83%BC%E3%83%8B%E3%83%B3%E3%82%B0)、行間など）を含んでいます。
 <!--
-After a font asset is compiled it can be loaded as a @'Stride.Graphics.SpriteFont' instance using the @'Stride.Core.Serialization.Assets.ContentManager'. It contains all the options to display a text (bitmaps, kerning, line spacing etc).
+After a font asset is compiled it can be loaded as a @'Stride.Graphics.SpriteFont' instance using the @'Stride.Core.Serialization.Contents.ContentManager'. It contains all the options to display a text (bitmaps, kerning, line spacing etc).
 -->
 
 **Code:** スプライトフォントを読み込む
@@ -47,9 +47,9 @@ var myFont = Content.Load<SpriteFont>("MyFont");
 ## Write text on screen
 -->
 
-フォントを読み込んだら、@'Stride.Graphics.SpriteBatch' で任意のテキストを表示することができます。描画を行うのは、@'Stride.Graphics.SpriteBatch.DrawString' メソッドです。スプライトバッチの詳細については、[スプライト バッチ](spritebatch.md)を参照してください。
+フォントを読み込んだら、@'Stride.Graphics.SpriteBatch' で任意のテキストを表示することができます。描画を行うのは、@'Stride.Graphics.SpriteBatch.DrawString*' メソッドです。スプライトバッチの詳細については、[スプライト バッチ](spritebatch.md)を参照してください。
 <!--
-Once the font is loaded, you can display any text with a @'Stride.Graphics.SpriteBatch'. The @'Stride.Graphics.SpriteBatch.DrawString' method performs the draw. For more information about the SpriteBatch, see the [SpriteBatch](spritebatch.md) page.
+Once the font is loaded, you can display any text with a @'Stride.Graphics.SpriteBatch'. The @'Stride.Graphics.SpriteBatch.DrawString*' method performs the draw. For more information about the SpriteBatch, see the [SpriteBatch](spritebatch.md) page.
 -->
 
 **コード：** テキストを書く