Skip to content

Commit 20f2bf8

Browse files
cdhannaSimonDarksideJmmckeehanjani-rgenericb
authored
2dshader tutorial
* Updated samples page (MonoGame#149) * Add samples section to main docs links * Updated samples page * Update index.md (MonoGame#147) corrected spelling on line 20 * Update index.md (MonoGame#146) Lines 211 - 214 (Key changes made): There was an update needed to this. Previous stated the file name was "04B_11.ttf" and the size was "32". The update is to match the snippet and the download. * Update textureregion.cs (MonoGame#153) Fix the comments for the constructor * typo (MonoGame#152) * Update WhatIs_Sprite.md (MonoGame#151) Corrected coordinates in the overview section * removed accidental backtick in CLI command (MonoGame#150) * "the" (MonoGame#154) * Update core.cs * Update tilemap.cs * Update core.cs * Update core.cs * Update core.cs * Update index.md * Fix for AudioController.Update() at 2d game tutorial. (MonoGame#148) * fix for AudioController.Update() at 2d game tutorial. * update code with backward iteration --------- Co-authored-by: Hyunwook Ha <[email protected]> * fix(docs): correct typos and improve consistency across articles (MonoGame#145) * Clarify distance labels in circle collision explanation - Added missing word "circles" in description of 'a' - Reworded all three distance descriptions for clarity and consistency * fix(title scene draw): remove unused color assignment to dropShadowColor * fix(title scene draw): add missing comment above dropShadowColor assignment * refactor: fix typo in textureatlas.cs filename * fix(docs): correct typos and improve wording across documentation * (Fix)Removed < > from xref links and set unordered list to ordered list --------- Co-authored-by: Simon (Darkside) Jackson <[email protected]> * Update Roadmap - Resolves MonoGame#137 * Add Maui instructions to "Getting Started guide" and add image - resolves MonoGame#157 * Fix formatting of Tip Admonition (MonoGame#159) * Changes to satisfy #225 (MonoGame#156) * Changes to satisfy #226 * Remove create as it moved to the main site * Fix footer to match * Update links for Bsky and mastodon * Revert MonoGame checkout to 3.8.4 * fix spelling mistake in the ContentManager Methods section of chapter 5 bulding 2d games tutorial (MonoGame#160) * working * Remove exiting from Game1 class and make ExitOnEscape true by default in the core class (MonoGame#163) * Update to remove the usage of the word "objects" which can be confused for OOP (MonoGame#162) * Add info about security and protection (MonoGame#161) * material class * debug ui * working * Gum styling update 2025 8 (MonoGame#164) * Updated styling docs to use ButtonVisual Updated using statements to match new gum namespace * Fixed usings * Upped NuGet versions for MonoGame Docs * Oops forgot this using statement. * Upped version number * Addressed feedback from AristurtleDev * Updated Cartblanch's Samples links and text. * color swap mostly complete * vertex shaders * Fix typo with iOS build instructions (MonoGame#167) * Fix minor Markdown error in CH 21 of the 2D game tutorial (MonoGame#168) * getting started on lighting * in progress * finishing draft of lighitng chapter * shadow stuff * before stencil * mostly done * stencil shadows * zug zug * remove old name * rename folder, update toc, and gif support * metadata * typos * links and callouts * hlsl highlighting support * fixing indentation --------- Co-authored-by: Simon (Darkside) Jackson <[email protected]> Co-authored-by: Mckeehan <[email protected]> Co-authored-by: jani-r <[email protected]> Co-authored-by: bo <[email protected]> Co-authored-by: Quaspen <[email protected]> Co-authored-by: Hyunwook Ha <[email protected]> Co-authored-by: Hyunwook Ha <[email protected]> Co-authored-by: Quest <[email protected]> Co-authored-by: Christopher Whitley <[email protected]> Co-authored-by: Sean Buchas <[email protected]> Co-authored-by: Victor Chelaru <[email protected]> Co-authored-by: Dominique Louis <[email protected]> Co-authored-by: buymyhubs <[email protected]> Co-authored-by: alfuwu <[email protected]>
1 parent 33381d6 commit 20f2bf8

File tree

251 files changed

+6308
-737
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

251 files changed

+6308
-737
lines changed

articles/console_access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: How do I get access to console versions of MonoGame?
55

66
MonoGame is free to use on all platforms from the [public repository](https://github.dev/MonoGame/monogame), but the code for supporting console platforms is only accessible to authorized console developers.
77

8-
These platforms are provided as private code repositories that add integrations with the console vendor's APIs and platform specific documentation.
8+
These platforms are provided as private code repositories that add integrations with the console vendor's APIs and platform-specific documentation.
99

1010
## Application process
1111

@@ -23,7 +23,7 @@ The instructions below will help you gain access to each platform.
2323

2424
![Nintendo Switch](images/nintendo_switch.png)
2525

26-
Your first step is to register as [Nintendo Developer](https://developer.nintendo.com/register) for Nintendo Switch.
26+
Your first step is to register as a [Nintendo Developer](https://developer.nintendo.com/register) for Nintendo Switch.
2727

2828
Once you are in the program, you can go to the middleware page and fill out the [MonoGame - Nintendo Developer Authorization](https://developer.nintendo.com/group/development/getting-started/g1kr9vj6/middleware/monogame) form.
2929

articles/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Thank you for choosing to contribute to the MonoGame project! This page provides
1919

2020
The MonoGame documentation contains two types of documents: articles and API references.
2121

22-
Articles include manuals, guides and tutorials on how to use the MonoGame Framework to create games.
22+
Articles include manuals, guides, and tutorials on how to use the MonoGame Framework to create games.
2323

2424
API references provide detailed explanation of each class and method found in the MonoGame Framework. The documentation is written in the [C# XML format](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/xmldoc/xml-documentation-comments) and is inline to the MonoGame source code.
2525

@@ -68,7 +68,7 @@ Being inline with the code allows you to easily look for critical information wi
6868

6969
### Focus on What Adds Value to the Consumer
7070

71-
Limit documentation to public methods and functions unless there is a specific reason to include internal methods, while documenting internals helps with readability of the code, it provides limited use to consumers of the MonoGame Framework.
71+
Limit documentation to public methods and functions unless there is a specific reason to include internal methods, while documenting internals helps with the readability of the code, it provides limited use to consumers of the MonoGame Framework.
7272

7373
### Documentation Is Referenced Not Read
7474

@@ -94,7 +94,7 @@ With a few points to call out:
9494

9595
#### `<see>` and `<cref/>` should be used whenever an API reference is used in the documentation
9696

97-
To ensure that API documentation is linked to whichever reference is used, `<see>` and `<cref/>` references should be used, this helps users navigate the methods, especially when looking up initializers or use of a property or method.
97+
To ensure that API documentation is linked to whichever reference is used, `<see>` and `<cref/>` references should be used. This helps users navigate the methods, especially when looking up initializers or use of a property or method.
9898

9999
#### Avoid self referencing `<cref/>` unless it provides value
100100

@@ -121,7 +121,7 @@ and the y component uses 6 bits.
121121

122122
> [!NOTE]
123123
> If the `cref` description would cause the line to exceed the 120 recommendation, this is generally ok, so long as the rendered line does not exceed the limit.
124-
> THe limit however, is more of a guideline than a hard rule, so common sense should be applied to keep the limit near 120 characters.
124+
> The limit however, is more of a guideline than a hard rule, so common sense should be applied to keep the limit near 120 characters.
125125
126126
#### Use the packed multi-line style with surrounding tags
127127

articles/getting_started/2_choosing_your_ide_vscode.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ The .NET MAUI extension adds features for building mobile apps, including:
9191
- Easy target switching - Change debug/deploy targets between different mobile platforms
9292
- Enhanced C# Dev Kit integration - Leverages Solution Explorer, Test Explorer, and advanced language features
9393

94+
![Install .NET MAUI DevKit Extension](../tutorials/building_2d_games/02_getting_started/images/maui-extension.png)
95+
9496
> [!NOTE]
9597
> This extension is recommended if you wish to do iOS or Android development. It is required for debugging support when working on mobile games.
9698

articles/getting_started/platforms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Building for Android also requires the Java 11 JDK (we recommend that you use [t
101101

102102
The iOS platform uses [Xamarin.iOS](https://docs.microsoft.com/en-us/xamarin/ios/). **OpenGL** is used for graphics, and OpenAL for audio.
103103

104-
Building for Android requires the .NET Xamarin component to be installed. You can install it with the Visual Studio installer (if you are using Visual Studio) or with the CLI command `dotnet workload install ios` (if you are working with Rider, VS Code, or the CLI).
104+
Building for iOS requires the .NET Xamarin component to be installed. You can install it with the Visual Studio installer (if you are using Visual Studio) or with the CLI command `dotnet workload install ios` (if you are working with Rider, VS Code, or the CLI).
105105

106106
The latest version of Xcode will also be required.
107107

articles/getting_to_know/whatis/graphics/WhatIs_Sprite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Sprites are 2D bitmaps that are drawn directly to a render target without using
1717

1818
## Overview
1919

20-
Sprites are positioned on the screen by coordinates. The width and height of the screen is the same as the back buffer. The x-axis represents the screen width and the y-axis represents the screen height. The y-axis is measured from the top of the screen and increases as you move **down** the screen, and the x-axis is measured from left to right. For example, when the graphics back buffer is 800×600, 0,0 is the upper left of the screen, and 800,600 is the lower right of the screen.
20+
Sprites are positioned on the screen by coordinates. The width and height of the screen is the same as the back buffer. The x-axis represents the screen width and the y-axis represents the screen height. The y-axis is measured from the top of the screen and increases as you move **down** the screen, and the x-axis is measured from left to right. For example, when the graphics back buffer is 800×600, the top left corner is at (0,0) and the bottom-right pixel is at (799,599).
2121

2222
To draw a sprite, create a [SpriteBatch](xref:Microsoft.Xna.Framework.Graphics.SpriteBatch) object, initialize it by calling [Begin](/api/Microsoft.Xna.Framework.Graphics.SpriteBatch.html#Microsoft_Xna_Framework_Graphics_SpriteBatch_Begin_Microsoft_Xna_Framework_Graphics_SpriteSortMode_Microsoft_Xna_Framework_Graphics_BlendState_Microsoft_Xna_Framework_Graphics_SamplerState_Microsoft_Xna_Framework_Graphics_DepthStencilState_Microsoft_Xna_Framework_Graphics_RasterizerState_Microsoft_Xna_Framework_Graphics_Effect_System_Nullable_Microsoft_Xna_Framework_Matrix__), and then call [Draw](/api/Microsoft.Xna.Framework.Graphics.SpriteBatch.html#Microsoft_Xna_Framework_Graphics_SpriteBatch_Draw_Microsoft_Xna_Framework_Graphics_Texture2D_Microsoft_Xna_Framework_Rectangle_Microsoft_Xna_Framework_Color_) for each sprite. The bitmap data for a sprite is taken from a [Texture2D](xref:Microsoft.Xna.Framework.Graphics.Texture2D) object. The texture may contain alpha channel information to make part of the texture transparent or semi-transparent. You can tint, rotate, or scale sprites by using [Draw](/api/Microsoft.Xna.Framework.Graphics.SpriteBatch.html#Microsoft_Xna_Framework_Graphics_SpriteBatch_Draw_Microsoft_Xna_Framework_Graphics_Texture2D_Microsoft_Xna_Framework_Rectangle_Microsoft_Xna_Framework_Color_). This method also gives you the option of drawing only part of the texture on the screen. After you draw a sprite, call [End](/api/Microsoft.Xna.Framework.Graphics.SpriteBatch.html#Microsoft_Xna_Framework_Graphics_SpriteBatch_End) before calling [Present](xref:Microsoft.Xna.Framework.Graphics.GraphicsDevice.Present).
2323

articles/help_and_support.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ title: Help and Support
33
description: Where to get help and support when using MonoGame.
44
---
55

6-
There is a wealth of [community created content, blogs and tutorials](tutorials/index.md) available.
6+
There is a wealth of [community-created content, blogs and tutorials](tutorials/index.md) available.
77

8-
You can also chat to other MonoGame users via [Discord](https://discord.com/invite/monogame).
8+
You can also chat with other MonoGame users via [Discord](https://discord.com/invite/monogame).
99

1010
If you want to find an answer to a more specific problem, you can ask it on our [GitHub Discussions](https://github.com/MonoGame/MonoGame/discussions) page.
1111

1212
## Bugs and feature requests
1313

14-
If you find a bug or have a feature request, [please open a new issue](https://github.com/mono/monogame/issues). Before opening any issue, please search for existing issues.
14+
If you find a bug or have a feature request, [please open a new issue](https://github.com/mono/monogame/issues). Before opening an issue, please check for existing ones.
1515

1616
Please note that the issue tracker is not for requesting help.

articles/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This documentation [helps you to get started](getting_started/index.md) by provi
2020

2121
Please use the links at the top and left to navigate the documentation sections.
2222

23-
> This documentation assume that the reader has a basic knowledge of the C# programming language.
23+
> This documentation assumes that the reader has a basic knowledge of the C# programming language.
2424
2525
## What is MonoGame exactly?
2626

@@ -36,4 +36,4 @@ If you love coding and understanding how things work under the hood, MonoGame mi
3636

3737
MonoGame is an open-source project maintained by its community. Great open source projects require high-quality documentation. This is a call for volunteers to continue to help us make the MonoGame documentation truly great. If you can create tutorials, feature guides, code snippets, reference docs, video walkthroughs, or make any improvement to the current documentation, we could use your help!
3838

39-
Check out the [README on GitHub](https://github.com/MonoGame/MonoGame/blob/develop/README.md) or [talk with us on discord](https://discord.gg/monogame) to learn how to help!
39+
Check out the [README on GitHub](https://github.com/MonoGame/MonoGame/blob/develop/README.md) or [talk with us on Discord](https://discord.gg/monogame) to learn how to help!

0 commit comments

Comments
 (0)