Skip to content

Commit fe8f7ff

Browse files
committed
Merge remote-tracking branch 'origin/master' into 1.11
2 parents 715f219 + d481e47 commit fe8f7ff

File tree

9 files changed

+100
-28
lines changed

9 files changed

+100
-28
lines changed

manual/editor/flax-build/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This documentation section covers most of the topics related to Flax.Build tool.
2525
* [API tags](api-tags.md)
2626
* [Build Plugin](plugins.md)
2727
* [Build Tool Guide](guide.md)
28+
* [Nuget Packages](nuget-packages.md)
2829

2930
## Build Scripts
3031

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Nuget Packages
2+
3+
Flax.Build allows using Nuget Packages.
4+
5+
To add a Nuget Package, open your build.cs module and add code that is similar to the following in the `Setup` method. Flax will automatically download the Nuget package if needed.
6+
7+
```cs
8+
public override void Setup(BuildOptions options)
9+
{
10+
base.Setup(options);
11+
12+
options.NugetPackages.Add("<nuget package name>", "<nuget package version>", "<framework version to use>")
13+
}
14+
```
15+
16+
Once the script files are regenerated, the nuget package will be available to use in the module.

manual/get-started/linux.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ You can get Flax from your [Download](https://flaxengine.com/download/) page, or
88

99
The Editor executable is located in folder `Binaries/Editor/Linux/Development/FlaxEditor` (you can use also Debug or Release configuration if you want).
1010

11+
### Third Party Launchers
12+
13+
* [Seed](https://github.com/MineBill/Seed) - Seed is a cross-platform launcher for Flax that manages multiple engine versions and projects.
14+
1115
## Requirements
1216

1317
For developers using Flax Editor on Linux platforms the requirements are:

manual/graphics/cameras/index.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22

33
![Camera](media/camera.png)
44

5-
**Camera** captures the scene and displays it to the user. It defines a view in screen space. A camera's position and rotaton define the *viewport* and *view direction*. Those properties are used to render scene objects and present them to the user.
5+
**Camera** captures the scene and displays it to the user. It defines a view in screen space. A camera's position and rotation define the *viewport* and *view direction*. Those properties are used to render scene objects and present them to the user.
6+
7+
## Changing the active camera
68

79
Flax Engine allows to create an unlimited amount of cameras in scenes while the [main one](http://docs.flaxengine.com/api/FlaxEngine.Camera.html#FlaxEngine_Camera_MainCamera) is used for the final frame rendering.
810

11+
To change the camera used for rendering, you can use the following code, where `MyCamera` is the camera you want to change to:
12+
13+
```cs
14+
Camera.OverrideMainCamera = MyCamera;
15+
```
16+
917
## Creating a camera in the editor
1018

1119
In the *Scene* tree window, right-click and select **New -> Camera**.
@@ -33,18 +41,20 @@ To learn more about the C# scripting API see the [Camera](http://docs.flaxengine
3341

3442
## Camera properties
3543

36-
![Camera Propertiess](media/camera-properties.png)
44+
![Camera Properties](media/camera-properties.png)
3745

3846
| Property | Description |
3947
|--------|--------|
40-
| **Field Of View** | The vertical field of view (in degrees) used for perspective projection. |
4148
| **Use Perspective** | If checked, camera will use perspective projection, otherwise orthographic. |
49+
| **Field Of View** | The vertical field of view (in degrees) used for perspective projection. |
4250
| **Near Plane** | The nearest point the camera can see (near clipping plane). |
4351
| **Far Plane** | The furthest point the camera can see (far clipping plane). |
4452
| **Custom Aspect Ratio** | Custom aspect ratio you specify. Otherwise, automatically adjust the aspect ratio to the render target ratio. Use value 0 to disable it. |
45-
| **Orthographic Size** | The orthographic projection view height (width is based on the aspect ratio). Use `0` for size to be based on the viewport size. |
46-
| **Orthographic Scale** | Additional scale used for the orthographic projection size. This has the effect of zooming in and out. |
53+
| **Orthographic Size** | *Only visible when **Use Perspective** is false.* The orthographic projection view height (width is based on the aspect ratio). Use `0` for size to be based on the viewport size. |
54+
| **Orthographic Scale** | *Only visible when **Use Perspective** is false.* Additional scale used for the orthographic projection size. This has the effect of zooming in and out. |
4755
| **Render Layers Mask** | The layers mask used for rendering using this camera. Can be used to include or exclude specific actor layers from the drawing. |
56+
| **Render Flags** | Frame rendering flags used to switch between graphics features for this camera. See [ViewFlags](https://docs.flaxengine.com/api/FlaxEngine.ViewFlags.html) api reference. |
57+
| **Render Mode** | Describes frame rendering modes for this camera. See [ViewMode](https://docs.flaxengine.com/api/FlaxEngine.ViewMode.html). |
4858

4959
## Masking object layers
5060

@@ -106,7 +116,7 @@ Then, the renderer will use `R16G16B16A16` format for the image textures and pas
106116

107117
## Override view
108118

109-
Flax uses an extensible RenderTask system for high-level rendering achitecture. By default a game uses the `MainRenderTask.Instance` to drive the scene rendering into the main game viewport. You can use it to plug into the rendering pipeline for custom effects, rendering or view override.
119+
Flax uses an extensible RenderTask system for high-level rendering architecture. By default a game uses the `MainRenderTask.Instance` to drive the scene rendering into the main game viewport. You can use it to plug into the rendering pipeline for custom effects, rendering or view override.
110120

111121
# [C#](#tab/code-csharp)
112122
```cs

0 commit comments

Comments
 (0)