Skip to content

Commit

Permalink
📜Update guides and latest API changes (#127)
Browse files Browse the repository at this point in the history
* Start work for issue #126

* config: set next version and enabled by default

* docs: update to latest version of API v1.0.0-preview.30

* docs: update rendering text guide

* docs: update rendering textures guide

* docs: update rendering atlas textures guide

* docs: update sound guide

* docs: remove duplicate load content section and improve it

* ide: improve markdown snippets

* docs: make additional improvements to rendering text guide

* docs: make additional improvements to rendering text guide
  • Loading branch information
CalvinWilkinson authored Nov 6, 2023
1 parent 8fe5d70 commit 1aea5fc
Show file tree
Hide file tree
Showing 30 changed files with 687 additions and 1,014 deletions.
10 changes: 5 additions & 5 deletions .vscode/mdx.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
"scope": "mdx",
"prefix": "note-admonition",
"body": [
":::note ${1: Note Title}",
":::note ${1:Note Title}",
"${2: Note Content}",
":::\n"
],
Expand All @@ -70,7 +70,7 @@
"scope": "mdx",
"prefix": "tip-admonition",
"body": [
":::tip ${1: Note Title}",
":::tip ${1:Note Title}",
"${2: Note Content}",
":::\n"
],
Expand All @@ -80,7 +80,7 @@
"scope": "mdx",
"prefix": "info-admonition",
"body": [
":::info ${1: Note Title}",
":::info ${1:Note Title}",
"${2: Note Content}",
":::\n"
],
Expand All @@ -90,7 +90,7 @@
"scope": "mdx",
"prefix": "caution-admonition",
"body": [
":::caution ${1: Note Title}",
":::caution ${1:Note Title}",
"${2: Note Content}",
":::\n"
],
Expand All @@ -100,7 +100,7 @@
"scope": "mdx",
"prefix": "danger-admonition",
"body": [
":::danger ${1: Note Title}",
":::danger ${1:Note Title}",
"${2: Note Content}",
":::\n"
],
Expand Down
230 changes: 0 additions & 230 deletions docs/api/Velaptor.Content.ContentLoader.md

This file was deleted.

28 changes: 20 additions & 8 deletions docs/api/Velaptor.Content.Fonts.FontLoader.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,30 +59,42 @@ The loaded font.
Occurs when the [contentPathOrName](Velaptor.Content.Fonts.FontLoader.md#Velaptor.Content.Fonts.FontLoader.Load(string).contentPathOrName 'Velaptor.Content.Fonts.FontLoader.Load(string).contentPathOrName') argument is null or empty.

[CachingMetaDataException](Velaptor.Content.Exceptions.CachingMetaDataException.md 'Velaptor.Content.Exceptions.CachingMetaDataException')
Occurs if the metadata is missing or invalid.
Occurs if the metadata is invalid.

[System.IO.FileNotFoundException](https://docs.microsoft.com/en-us/dotnet/api/System.IO.FileNotFoundException 'System.IO.FileNotFoundException')
Occurs if the font file does not exist.

### Example

```csharp
// Valid Value
// Valid Example 1
ContentLoader.Load("my-font|size:12");

// Valid Value
<br/>
// Valid Example 2
ContentLoader.Load("my-font");
<br/>
// Valid Example 3
ContentLoader.Load("my-font.ttf");
<br/>
// Valid Example 4
ContentLoader.Load(@"C:\fonts\my-font.ttf|size:12");

// Invalid Value
<br/>
// Invalid Example 1
ContentLoader.Load("my-font|size:12");

<br/>
// Invalid Example 2
ContentLoader.Load("my-font|size:12");
<br/>
// Invalid Example 3
ContentLoader.Load("my-font|size12");
```

#### Remarks
If a path is used, it must be a fully qualified file path.

Directory paths are not valid.
Directory paths are not valid.

If no metadata is provided, then a default font size of 12 will be used.

<a name='Velaptor.Content.Fonts.FontLoader.Unload(string)'></a>

Expand Down
Loading

0 comments on commit 1aea5fc

Please sign in to comment.