diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..6313b56c --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.github/cicd/.vscode/settings.json b/.github/cicd/.vscode/settings.json index c7dabf49..48a5aede 100644 --- a/.github/cicd/.vscode/settings.json +++ b/.github/cicd/.vscode/settings.json @@ -1,5 +1,12 @@ { + "deno.enable": true, + "files.eol": "\n", + "files.exclude": { + "**/RepoSrc": true + }, "[typescript]": { "editor.defaultFormatter": "denoland.vscode-deno", - } + "editor.insertSpaces": false, + "editor.tabSize": 3, + }, } diff --git a/.github/cicd/core/services/MarkdownFileContentService.ts b/.github/cicd/core/services/MarkdownFileContentService.ts index 31b34200..a2605411 100644 --- a/.github/cicd/core/services/MarkdownFileContentService.ts +++ b/.github/cicd/core/services/MarkdownFileContentService.ts @@ -4,13 +4,14 @@ import { MarkdownHeaderService } from "./MarkdownHeaderService.ts"; import { MarkdownService } from "./MarkdownService.ts"; import { Utils } from "../Utils.ts"; import { basename, extname } from "../../deps.ts"; +import { ProcessFragmentService } from "./ProcessFragmentService.ts"; export class MarkdownFileContentService { private readonly markDownService: MarkdownService; private readonly markdownHeaderService: MarkdownHeaderService; private readonly htmlService: HTMLService; private readonly codeBlockService: CodeBlockService; - private readonly markDownLinkRegEx: RegExp; + private readonly singleLinkRegEx: RegExp; private readonly linkTagRegEx: RegExp; private readonly htmlArrow = "🡒"; @@ -19,7 +20,7 @@ export class MarkdownFileContentService { this.markdownHeaderService = new MarkdownHeaderService(); this.htmlService = new HTMLService(); this.codeBlockService = new CodeBlockService(); - this.markDownLinkRegEx = /\[(.*?)\]\((.*?)\)/g; + this.singleLinkRegEx = /\[.+?\]\(.+?\)/g; this.linkTagRegEx = /<\/a\s*>/; } @@ -61,6 +62,9 @@ export class MarkdownFileContentService { // Process all headers to change them to the appropriate size fileContent = this.markdownHeaderService.processHeaders(fileContent); + // Process all fragments in markdown links 👉🏼 [stuff](Item1.Item2#Item1.Item2) gets converted to [stuff](Item1.Item2#item2) + fileContent = this.processMarkdownLinkFragments(fileContent); + // Extract the name of the file without its extension const baseName = basename(filePath); const extension = extname(filePath); @@ -81,7 +85,7 @@ export class MarkdownFileContentService { const line = fileLines[i]; const linkTagMatches = line.match(this.linkTagRegEx); - const isLinkTag: boolean = linkTagMatches != null && linkTagMatches.length > 0; + const isLinkTag: boolean = linkTagMatches !== null && linkTagMatches.length > 0; if (isLinkTag) { let nameValue: string = this.htmlService.getNameAttrValue(line); @@ -94,6 +98,60 @@ export class MarkdownFileContentService { return Utils.toString(fileLines); } + /** + * Processes the given {@link fileContent} by finding all markdown links that contain fragments + * in the url and changes the fragment by setting it to lowercase, replacing spaces with hyphens, + * and removing all api namespace prefixes. + * @param fileContent The content of the file to process. + * @returns The processed file content. + */ + private processMarkdownLinkFragments(fileContent: string): string { + const fileLines: string[] = Utils.toLines(fileContent); + + const service = new ProcessFragmentService(); + + for (let i = 0; i < fileLines.length; i++) { + fileLines[i] = service.processFragments(fileLines[i]); + } + + return `${fileLines.join("\n")}\n`; + } + + /** + * Updates the url fragment in the given {@link markdownLink} if it contains some hover text + * and the fragment contains periods which means it is a fully qualified type name. + * @param markdownLink The markdown link. + * @returns The updated markdown link. + */ + private updateMarkdownLinkFragment(markdownLink: string): string { + const hoverTextRegex = /'.+?'/gm; + + const linkText = this.markDownService.extractLinkText(markdownLink); + const fullUrl = this.markDownService.extractLinkUrl(markdownLink); + const containsHoverText = hoverTextRegex.test(fullUrl); + const containsFragment = fullUrl.includes("#"); + + if (containsHoverText && containsFragment) { + const [urlSection, hoverTextSection] = fullUrl.split(" "); + + const [url, fragment] = urlSection.split("#"); + + if (fragment.includes(".")) { + const fragmentSections = fragment.split("."); + const fragmentIsGenericParam = fragment.includes("_T_"); + + const newFragment = fragmentIsGenericParam + ? "type-parameters" + : fragmentSections[fragmentSections.length - 1].toLowerCase().replace(" ", "-"); + + const newUrl = `${url}#${newFragment} ${hoverTextSection}`; + return this.markDownService.createLink(linkText, newUrl); + } + } + + return ""; + } + private processHeaderAngleBrackets(fileContent: string): string { if (Utils.isNothing(fileContent)) { return ""; @@ -120,8 +178,8 @@ export class MarkdownFileContentService { for (let i = 0; i < fileLines.length; i++) { const line = fileLines[i]; - const notEmpty = line != ""; - const containsAngles: boolean = line.indexOf("<") != -1 && line.indexOf(">") != -1; + const notEmpty = line !== ""; + const containsAngles: boolean = line.indexOf("<") !== -1 && line.indexOf(">") !== -1; const notCodeBlock = !this.codeBlockService.inAnyCodeBlocks(codeBlocks, i); const notHeader = !this.markDownService.isHeaderLine(line); const notHTMLLink = !this.htmlService.isHTMLLink(line); @@ -166,9 +224,9 @@ export class MarkdownFileContentService { for (let i = 0; i < fileLines.length; i++) { const line = fileLines[i]; - if (line.lastIndexOf("| |") != -1) { + if (line.lastIndexOf("| |") !== -1) { fileLines[i] = line.replace("| |", "|"); - } else if (line.indexOf("| :--- |") != -1) { + } else if (line.indexOf("| :--- |") !== -1) { fileLines[i] = "| :--- |"; } } @@ -181,7 +239,7 @@ export class MarkdownFileContentService { newUrl: string, predicate: ((text: string, url: string) => boolean) | null = null, ): string { - const matches = fileContent.match(this.markDownLinkRegEx); + const matches = fileContent.match(this.singleLinkRegEx); matches?.forEach((link) => { const text: string = this.markDownService.extractLinkText(link); const url: string = this.markDownService.extractLinkUrl(link); diff --git a/.github/cicd/core/services/MarkdownService.ts b/.github/cicd/core/services/MarkdownService.ts index bb1244e1..4974f581 100644 --- a/.github/cicd/core/services/MarkdownService.ts +++ b/.github/cicd/core/services/MarkdownService.ts @@ -19,7 +19,7 @@ export class MarkdownService { // /(?!.*\(\()/ is 2 consecutive ( parenthesis // /(?!.*\)\))/ is 2 consecutive ) parenthesis - this.fullMarkdownLinkRegEx = /(?!.*\[\[)(?!.*\]\])(?!.*\(\()(?!.*\)\))(\[.+\]\(.+\))/; + this.fullMarkdownLinkRegEx = /\[.+?\]\(.+?\)/gm; this.headerLineRegEx = /^#+ .+$/g; this.newLine = Utils.isWindows() ? "\r\n" : "\n"; @@ -32,7 +32,7 @@ export class MarkdownService { // TODO: The URL link is going to have to change somehow // once we start having versions. Maybe bring in a version parameter somehow - return `[${text}](<${url}>)`; + return `[${text}](${url})`; } public prefixUrl(markDownLink: string, prefix: string): string { @@ -56,6 +56,17 @@ export class MarkdownService { return `[${text}](${newUrl})`; } + /** + * Extracts all markdown links from the given {@link value}. + * @param value The value to extract markdown links from. + * @returns The markdown links. + */ + public extractMarkdownLink(value: string): string | undefined { + const matches = Array.from(value.matchAll(this.fullMarkdownLinkRegEx), (match) => match[0]); + + return matches.length > 0 ? matches[0] : undefined; + } + public extractLinkText(markDownLink: string): string { if (!this.containsMarkdownLink(markDownLink)) { throw new Error(`The markdown link is invalid.\`n${markDownLink}`); @@ -199,7 +210,6 @@ export class MarkdownService { return matches != null && matches.length > 0; } - public isCodeBlockStartLine(line: string): boolean { if (Utils.isNothing(line)) { return false; diff --git a/.github/cicd/core/services/ProcessFragmentService.ts b/.github/cicd/core/services/ProcessFragmentService.ts new file mode 100644 index 00000000..b0eac995 --- /dev/null +++ b/.github/cicd/core/services/ProcessFragmentService.ts @@ -0,0 +1,118 @@ +/** + * Processes URL fragments inside of markdown link URL text by converting them to lowercase and extracting only + * the member name from the fully qualified C# type. + */ +export class ProcessFragmentService { + private readonly leftBracket = "["; + private readonly leftParen = "("; + private readonly rightParen = ")"; + + /** + * Processes all markdown links in the given {@link text}. + * @param text The text to process. + * @returns The processed text. + */ + public processFragments(text: string): string { + const links: string[] = this.extractLinks(text); + + // Create all of the new links if they contain fragments + links.forEach((link) => { + const hoverTextRegex = /'.+'/g; + + const linkText = this.extractLinkText(link); + let linkUrl = this.extractLinkUrl(link); + + if (linkUrl.includes("#")) { + let hoverText = hoverTextRegex.exec(linkUrl)?.[0] ?? ""; + hoverText = hoverText === "" ? "" : ` ${hoverText}`; + + linkUrl = linkUrl.replace(hoverText, "").trimEnd(); + + let [fragPrefix, fragment] = linkUrl.split("#"); + + fragment = fragment.includes(".") ? fragment.split(".").pop() ?? "" : fragment; + + fragment = fragment.toLowerCase(); + + const newLink = `[${linkText}](${fragPrefix}#${fragment}${hoverText})`; + + text = text.replaceAll(link, newLink); + } + }); + + return text; + } + + /** + * Extracts all links from the given {@link text}. + * @param text The text to extract links from. + * @returns The extracted links. + */ + private extractLinks(text: string): string[] { + const links: string[] = []; + const link: string[] = []; + let insideLink = false; + let parenNestLevel = 0; + + for (let i = 0; i < text.length; i++) { + const char = text[i]; + + switch (char) { + case this.leftBracket: + insideLink = true; + link.push(char); + continue; + case this.leftParen: + parenNestLevel = i < text.length - 1 ? parenNestLevel + 1 : parenNestLevel; + break; + case this.rightParen: + link.push(char); + parenNestLevel -= 1; + + // If the paren next level is 0, then we are not inside a link + insideLink = parenNestLevel > 0; + + if (!insideLink) { + links.push(link.join("")); + + // Empty the array + link.length = 0; + } + continue; + } + + if (insideLink) { + link.push(char); + } + } + + return links; + } + + /** + * Extracts the link text from the given {@link markdownLink}. + * @param markdownLink The link to extract the text from. + * @returns The extracted link text. + */ + private extractLinkText(markdownLink: string): string { + const linkTextRegex = /\[.+?\]/g; + const result = (linkTextRegex.exec(markdownLink)?.[0] ?? "").replace("[", "").replace("]", ""); + + return result; + } + + /** + * Extracts the link URL from the given {@link markdownLink}. + * @param markdownLink The link to extract the URL from. + * @returns The extracted link URL. + */ + private extractLinkUrl(markdownLink: string): string { + const linkUrlRegex = /\(.+\)/; + let result = linkUrlRegex.exec(markdownLink)?.[0] ?? ""; + + result = result.startsWith("(") ? result.substring(1) : result; + result = result.endsWith(")") ? result.substring(0, result.length - 1) : result; + + return result; + } +} diff --git a/.github/cicd/playground.ts b/.github/cicd/playground.ts index f7e6db52..af43f5ca 100644 --- a/.github/cicd/playground.ts +++ b/.github/cicd/playground.ts @@ -1,3 +1,2 @@ - const _rootRepoDirPath = Deno.args[0]; const _token = Deno.args[1]; diff --git a/.github/cicd/scripts/generate-new-api-docs.ts b/.github/cicd/scripts/generate-new-api-docs.ts index 7c211b4a..2c866855 100644 --- a/.github/cicd/scripts/generate-new-api-docs.ts +++ b/.github/cicd/scripts/generate-new-api-docs.ts @@ -40,7 +40,7 @@ const apiVersionType: GenerateSrcType = "api version"; if (isInteractive) { // Ask for an API version or branch name - generateSrcType = (await Select.prompt({ + generateSrcType = (await Select.prompt({ message: "Enter the type of source you want to generate from.", options: [branchType, apiVersionType], })); @@ -49,7 +49,7 @@ if (isInteractive) { tagOrBranch = await Input.prompt({ message: "Enter the branch name", }); - } else if(generateSrcType === "api version") { + } else if (generateSrcType === "api version") { const token = Deno.env.get("CICD_TOKEN"); if (Utils.isNothing(token)) { @@ -62,13 +62,11 @@ if (isInteractive) { const tags = (await tagClient.getAllTags()).map((tag) => tag.name) .filter((tag) => Utils.validPreviewVersion(tag) || Utils.validProdVersion(tag)); - tagOrBranch = await Select.prompt({ message: "Select a release version", options: tags, }); - } else { console.error("Unknown source type selected."); Deno.exit(); diff --git a/.vscode/settings.json b/.vscode/settings.json index e965f435..1caf7e9e 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -3,6 +3,7 @@ ".github/cicd/" ], "deno.config": ".github/cicd/deno.json", + "files.eol": "\n", "cSpell.words": [ "cicd", "clsx", @@ -26,9 +27,9 @@ "node_modules": true, "VelaptorDocs.code-workspace": true, "build/": true, - ".github/cicd/": false, - ".config": false, - "RepoSrc/": true, + ".github/cicd/": true, + ".config": true, + "**/RepoSrc": true, "*.lock": true, "SampleProjects": true, }, diff --git a/.github/cicd/deno.json b/deno.json similarity index 95% rename from .github/cicd/deno.json rename to deno.json index 6f819d45..0e85cf1f 100644 --- a/.github/cicd/deno.json +++ b/deno.json @@ -3,7 +3,7 @@ "build": "deno run --allow-read --allow-env --allow-sys --allow-run ./scripts/deno-check.ts" }, "fmt": { - "include": ["**/*.ts"], + "include": [".github/cicd/**/*.ts"], "exclude": [ "**/.config/", "**/.docusaurus/", @@ -30,7 +30,7 @@ }, "nodeModulesDir": false, "lint": { - "include": ["**/*.ts"], + "include": [".github/cicd/**/*.ts"], "exclude": [ "**/*.json", "**/*.md", diff --git a/.github/cicd/deno.lock b/deno.lock similarity index 99% rename from .github/cicd/deno.lock rename to deno.lock index f21fb3ec..5c6483c7 100644 --- a/.github/cicd/deno.lock +++ b/deno.lock @@ -621,5 +621,27 @@ "https://raw.githubusercontent.com/KinsonDigital/Infrastructure/v13.6.3/cicd/core/Utils.ts": "e2c0dd08e79e79b616f6b5ff90ddac1d24847fa39d483354e4abee775e64fc35", "https://raw.githubusercontent.com/KinsonDigital/Infrastructure/v13.6.3/cicd/core/mod.ts": "8a80efd845c06db8329dd58d5d29cb4427b793fcd86a2230634fd60f233e59a5", "https://raw.githubusercontent.com/KinsonDigital/Infrastructure/v13.6.3/deps.ts": "8a380f4e2d6312114caafc6d1ef46061e9369865a549ca3852a6aab382270927" + }, + "workspace": { + "packageJson": { + "dependencies": [ + "npm:@docusaurus/core@3.5.1", + "npm:@docusaurus/module-type-aliases@^3.2.1", + "npm:@docusaurus/preset-classic@3.5.1", + "npm:@docusaurus/theme-mermaid@3.5.1", + "npm:@docusaurus/tsconfig@^3.2.1", + "npm:@docusaurus/types@3.5.1", + "npm:@mdx-js/react@^3.0.0", + "npm:@types/react@^18.2.42", + "npm:autoprefixer@^10.4.19", + "npm:clsx@2.1.1", + "npm:postcss@^8.4.38", + "npm:prism-react-renderer@^2.3.0", + "npm:react-dom@^18.2.0", + "npm:react@^18.2.0", + "npm:tailwindcss@^3.4.3", + "npm:typescript@~5.5.0" + ] + } } } diff --git a/docs/api/Namespaces.md b/docs/api/Namespaces.md index 7230c127..e07eeb58 100644 --- a/docs/api/Namespaces.md +++ b/docs/api/Namespaces.md @@ -27,3 +27,4 @@ title: Namespaces | [Velaptor.OpenGL.Exceptions](Velaptor.OpenGL.Exceptions.md 'Velaptor.OpenGL.Exceptions') | | [Velaptor.Scene](Velaptor.Scene.md 'Velaptor.Scene') | | [Velaptor.UI](Velaptor.UI.md 'Velaptor.UI') | + diff --git a/docs/api/Velaptor.App.md b/docs/api/Velaptor.App.md index e03bd4e7..9b8d03d1 100644 --- a/docs/api/Velaptor.App.md +++ b/docs/api/Velaptor.App.md @@ -47,4 +47,4 @@ The height of the render area. #### Returns [IRenderContext](Velaptor.Graphics.IRenderContext.md 'Velaptor.Graphics.IRenderContext') -The Avalonia render context. \ No newline at end of file +The Avalonia render context. diff --git a/docs/api/Velaptor.AppStats.md b/docs/api/Velaptor.AppStats.md index 55a1de09..3f0dbe59 100644 --- a/docs/api/Velaptor.AppStats.md +++ b/docs/api/Velaptor.AppStats.md @@ -56,4 +56,4 @@ public static string GetLoadedTextures(); #### Returns [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The string result of all the loaded textures. \ No newline at end of file +The string result of all the loaded textures. diff --git a/docs/api/Velaptor.Batching.IBatcher.md b/docs/api/Velaptor.Batching.IBatcher.md index 39418bac..2378a8a3 100644 --- a/docs/api/Velaptor.Batching.IBatcher.md +++ b/docs/api/Velaptor.Batching.IBatcher.md @@ -73,4 +73,4 @@ Ends the batch process. Calling this will perform the actual GPU render process ```csharp void End(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Batching.md b/docs/api/Velaptor.Batching.md index 6a6b7dcd..082b1bf8 100644 --- a/docs/api/Velaptor.Batching.md +++ b/docs/api/Velaptor.Batching.md @@ -9,3 +9,4 @@ title: Velaptor.Batching | Interfaces | | | :--- | :--- | | [IBatcher](Velaptor.Batching.IBatcher.md 'Velaptor.Batching.IBatcher') | Provides the ability to start and end the batch rendering process. | + diff --git a/docs/api/Velaptor.Content.AtlasData.md b/docs/api/Velaptor.Content.AtlasData.md index a78ca266..ce95c81b 100644 --- a/docs/api/Velaptor.Content.AtlasData.md +++ b/docs/api/Velaptor.Content.AtlasData.md @@ -30,7 +30,7 @@ Gets the file path to the atlas data. public string AtlasDataFilePath { get; } ``` -Implements [AtlasDataFilePath](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.AtlasDataFilePath 'Velaptor.Content.IAtlasData.AtlasDataFilePath') +Implements [AtlasDataFilePath](Velaptor.Content.IAtlasData.md#atlasdatafilepath 'Velaptor.Content.IAtlasData.AtlasDataFilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -45,7 +45,7 @@ Gets the path to the texture. public string FilePath { get; } ``` -Implements [FilePath](Velaptor.Content.IContent.md#Velaptor.Content.IContent.FilePath 'Velaptor.Content.IContent.FilePath') +Implements [FilePath](Velaptor.Content.IContent.md#filepath 'Velaptor.Content.IContent.FilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -60,7 +60,7 @@ Gets the height of the entire texture atlas texture. public uint Height { get; } ``` -Implements [Height](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.Height 'Velaptor.Content.IAtlasData.Height') +Implements [Height](Velaptor.Content.IAtlasData.md#height 'Velaptor.Content.IAtlasData.Height') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -75,7 +75,7 @@ Gets the name of the atlas. public string Name { get; } ``` -Implements [Name](Velaptor.Content.IContent.md#Velaptor.Content.IContent.Name 'Velaptor.Content.IContent.Name') +Implements [Name](Velaptor.Content.IContent.md#name 'Velaptor.Content.IContent.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -90,7 +90,7 @@ Gets a list of unique sub texture names. public System.Collections.Generic.IReadOnlyCollection SubTextureNames { get; } ``` -Implements [SubTextureNames](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.SubTextureNames 'Velaptor.Content.IAtlasData.SubTextureNames') +Implements [SubTextureNames](Velaptor.Content.IAtlasData.md#subtexturenames 'Velaptor.Content.IAtlasData.SubTextureNames') #### Property Value [System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') @@ -109,7 +109,7 @@ Gets the texture of the atlas. public Velaptor.Content.ITexture Texture { get; } ``` -Implements [Texture](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.Texture 'Velaptor.Content.IAtlasData.Texture') +Implements [Texture](Velaptor.Content.IAtlasData.md#texture 'Velaptor.Content.IAtlasData.Texture') #### Property Value [ITexture](Velaptor.Content.ITexture.md 'Velaptor.Content.ITexture') @@ -131,7 +131,7 @@ public Velaptor.Graphics.AtlasSubTextureData this[int index] { get; } The index of the item to retrieve. -Implements [this[int]](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.this[int] 'Velaptor.Content.IAtlasData.this[int]') +Implements [this[int](Velaptor.Content.IAtlasData.md#this[int] 'Velaptor.Content.IAtlasData.this[int]') #### Property Value [AtlasSubTextureData](Velaptor.Graphics.AtlasSubTextureData.md 'Velaptor.Graphics.AtlasSubTextureData') @@ -146,7 +146,7 @@ Gets the width of the entire texture atlas texture. public uint Width { get; } ``` -Implements [Width](Velaptor.Content.IAtlasData.md#Velaptor.Content.IAtlasData.Width 'Velaptor.Content.IAtlasData.Width') +Implements [Width](Velaptor.Content.IAtlasData.md#width 'Velaptor.Content.IAtlasData.Width') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -173,4 +173,4 @@ Implements [GetFrames(string)](Velaptor.Content.IAtlasData.md#Velaptor.Content.I #### Returns [AtlasSubTextureData](Velaptor.Graphics.AtlasSubTextureData.md 'Velaptor.Graphics.AtlasSubTextureData')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The list of frame rectangles. \ No newline at end of file +The list of frame rectangles. diff --git a/docs/api/Velaptor.Content.Audio.md b/docs/api/Velaptor.Content.Audio.md index bc5d639a..e847928d 100644 --- a/docs/api/Velaptor.Content.Audio.md +++ b/docs/api/Velaptor.Content.Audio.md @@ -31,7 +31,7 @@ A single audio that can be played, paused etc. public Velaptor.Content.AudioBuffer BufferType { get; } ``` -Implements [BufferType](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.BufferType 'Velaptor.Content.IAudio.BufferType') +Implements [BufferType](Velaptor.Content.IAudio.md#buffertype 'Velaptor.Content.IAudio.BufferType') #### Property Value [AudioBuffer](Velaptor.Content.AudioBuffer.md 'Velaptor.Content.AudioBuffer') @@ -46,7 +46,7 @@ A single audio that can be played, paused etc. public string FilePath { get; } ``` -Implements [FilePath](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.FilePath 'Velaptor.Content.IAudio.FilePath'), [FilePath](Velaptor.Content.IContent.md#Velaptor.Content.IContent.FilePath 'Velaptor.Content.IContent.FilePath') +Implements [FilePath](Velaptor.Content.IAudio.md#filepath 'Velaptor.Content.IAudio.FilePath'), [FilePath](Velaptor.Content.IContent.md#filepath 'Velaptor.Content.IContent.FilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -61,7 +61,7 @@ Gets the unique ID of the audio. public uint Id { get; set; } ``` -Implements [Id](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Id 'Velaptor.Content.IAudio.Id') +Implements [Id](Velaptor.Content.IAudio.md#id 'Velaptor.Content.IAudio.Id') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -76,7 +76,7 @@ A single audio that can be played, paused etc. public bool IsLooping { get; set; } ``` -Implements [IsLooping](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.IsLooping 'Velaptor.Content.IAudio.IsLooping') +Implements [IsLooping](Velaptor.Content.IAudio.md#islooping 'Velaptor.Content.IAudio.IsLooping') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -91,7 +91,7 @@ A single audio that can be played, paused etc. public bool IsPaused { get; } ``` -Implements [IsPaused](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.IsPaused 'Velaptor.Content.IAudio.IsPaused') +Implements [IsPaused](Velaptor.Content.IAudio.md#ispaused 'Velaptor.Content.IAudio.IsPaused') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -106,7 +106,7 @@ A single audio that can be played, paused etc. public bool IsPlaying { get; } ``` -Implements [IsPlaying](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.IsPlaying 'Velaptor.Content.IAudio.IsPlaying') +Implements [IsPlaying](Velaptor.Content.IAudio.md#isplaying 'Velaptor.Content.IAudio.IsPlaying') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -121,7 +121,7 @@ A single audio that can be played, paused etc. public bool IsStopped { get; } ``` -Implements [IsStopped](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.IsStopped 'Velaptor.Content.IAudio.IsStopped') +Implements [IsStopped](Velaptor.Content.IAudio.md#isstopped 'Velaptor.Content.IAudio.IsStopped') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -136,7 +136,7 @@ A single audio that can be played, paused etc. public System.TimeSpan Length { get; } ``` -Implements [Length](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Length 'Velaptor.Content.IAudio.Length') +Implements [Length](Velaptor.Content.IAudio.md#length 'Velaptor.Content.IAudio.Length') #### Property Value [System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan') @@ -151,7 +151,7 @@ A single audio that can be played, paused etc. public string Name { get; } ``` -Implements [Name](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Name 'Velaptor.Content.IAudio.Name'), [Name](Velaptor.Content.IContent.md#Velaptor.Content.IContent.Name 'Velaptor.Content.IContent.Name') +Implements [Name](Velaptor.Content.IAudio.md#name 'Velaptor.Content.IAudio.Name'), [Name](Velaptor.Content.IContent.md#name 'Velaptor.Content.IContent.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -166,7 +166,7 @@ A single audio that can be played, paused etc. public float PlaySpeed { get; set; } ``` -Implements [PlaySpeed](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.PlaySpeed 'Velaptor.Content.IAudio.PlaySpeed') +Implements [PlaySpeed](Velaptor.Content.IAudio.md#playspeed 'Velaptor.Content.IAudio.PlaySpeed') #### Property Value [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') @@ -181,7 +181,7 @@ A single audio that can be played, paused etc. public System.TimeSpan Position { get; } ``` -Implements [Position](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Position 'Velaptor.Content.IAudio.Position') +Implements [Position](Velaptor.Content.IAudio.md#position 'Velaptor.Content.IAudio.Position') #### Property Value [System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan') @@ -196,7 +196,7 @@ A single audio that can be played, paused etc. public float Volume { get; set; } ``` -Implements [Volume](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Volume 'Velaptor.Content.IAudio.Volume') +Implements [Volume](Velaptor.Content.IAudio.md#volume 'Velaptor.Content.IAudio.Volume') #### Property Value [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') @@ -299,4 +299,4 @@ A single audio that can be played, paused etc. public void Stop(); ``` -Implements [Stop()](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Stop() 'Velaptor.Content.IAudio.Stop()') \ No newline at end of file +Implements [Stop()](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Stop() 'Velaptor.Content.IAudio.Stop()') diff --git a/docs/api/Velaptor.Content.AudioBuffer.md b/docs/api/Velaptor.Content.AudioBuffer.md index f05a3643..d4fba012 100644 --- a/docs/api/Velaptor.Content.AudioBuffer.md +++ b/docs/api/Velaptor.Content.AudioBuffer.md @@ -30,8 +30,8 @@ All the audio data has been loaded into memory. - Large audio files that take up much more memory. - Large audio files take longer when loading as content.
- It is recommended to use [Full](Velaptor.Content.AudioBuffer.md#Velaptor.Content.AudioBuffer.Full 'Velaptor.Content.AudioBuffer.Full') for very short audio effects such as lasers, weapons, etc. and - to use [Stream](Velaptor.Content.AudioBuffer.md#Velaptor.Content.AudioBuffer.Stream 'Velaptor.Content.AudioBuffer.Stream') for large files such as game music. + It is recommended to use [Full](Velaptor.Content.AudioBuffer.md#full 'Velaptor.Content.AudioBuffer.Full') for very short audio effects such as lasers, weapons, etc. and + to use [Stream](Velaptor.Content.AudioBuffer.md#stream 'Velaptor.Content.AudioBuffer.Stream') for large files such as game music. @@ -48,5 +48,5 @@ Audio data is streamed from a source during playback. Not Good For: - Sounds that need to be played in quick succession such as audio effects.
- It is recommended to use [Stream](Velaptor.Content.AudioBuffer.md#Velaptor.Content.AudioBuffer.Stream 'Velaptor.Content.AudioBuffer.Stream') for large files such as game music and to use [Full](Velaptor.Content.AudioBuffer.md#Velaptor.Content.AudioBuffer.Full 'Velaptor.Content.AudioBuffer.Full') - for very short audio effects such as lasers, weapons, etc. \ No newline at end of file + It is recommended to use [Stream](Velaptor.Content.AudioBuffer.md#stream 'Velaptor.Content.AudioBuffer.Stream') for large files such as game music and to use [Full](Velaptor.Content.AudioBuffer.md#full 'Velaptor.Content.AudioBuffer.Full') + for very short audio effects such as lasers, weapons, etc. diff --git a/docs/api/Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md b/docs/api/Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md index 8daec4da..86e74827 100644 --- a/docs/api/Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md +++ b/docs/api/Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md @@ -58,7 +58,7 @@ int TotalCachedItems { get; } ### GetItem(TCacheKey) -Gets a cached item that matches the given [cacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.GetItem(TCacheKey).cacheKey 'Velaptor.Content.Caching.IItemCache.GetItem(TCacheKey).cacheKey'). +Gets a cached item that matches the given [cacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#cachekey 'Velaptor.Content.Caching.IItemCache.GetItem(TCacheKey).cacheKey'). ```csharp TCacheType GetItem(TCacheKey cacheKey); @@ -67,12 +67,12 @@ TCacheType GetItem(TCacheKey cacheKey); -`cacheKey` [TCacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.TCacheKey 'Velaptor.Content.Caching.IItemCache.TCacheKey') +`cacheKey` [TCacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#tcachekey 'Velaptor.Content.Caching.IItemCache.TCacheKey') The unique key to identify a cached item. #### Returns -[TCacheType](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.TCacheType 'Velaptor.Content.Caching.IItemCache.TCacheType') +[TCacheType](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#tcachetype 'Velaptor.Content.Caching.IItemCache.TCacheType') The cached item. #### Remarks @@ -85,7 +85,7 @@ If the item does already exist in the cache, then that cached item is returned. ### Unload(TCacheKey) -Unloads a cached item that matches the given [cacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.Unload(TCacheKey).cacheKey 'Velaptor.Content.Caching.IItemCache.Unload(TCacheKey).cacheKey'). +Unloads a cached item that matches the given [cacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#cachekey 'Velaptor.Content.Caching.IItemCache.Unload(TCacheKey).cacheKey'). ```csharp void Unload(TCacheKey cacheKey); @@ -94,6 +94,6 @@ void Unload(TCacheKey cacheKey); -`cacheKey` [TCacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.TCacheKey 'Velaptor.Content.Caching.IItemCache.TCacheKey') +`cacheKey` [TCacheKey](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md#tcachekey 'Velaptor.Content.Caching.IItemCache.TCacheKey') -The unique key to identify a cached item. \ No newline at end of file +The unique key to identify a cached item. diff --git a/docs/api/Velaptor.Content.Caching.md b/docs/api/Velaptor.Content.Caching.md index 8c0d83c4..78401b5d 100644 --- a/docs/api/Velaptor.Content.Caching.md +++ b/docs/api/Velaptor.Content.Caching.md @@ -9,3 +9,4 @@ title: Velaptor.Content.Caching | Interfaces | | | :--- | :--- | | [IItemCache<TCacheKey,TCacheType>](Velaptor.Content.Caching.IItemCache_TCacheKey,TCacheType_.md 'Velaptor.Content.Caching.IItemCache') | Caches items for retrieval at a later time. | + diff --git a/docs/api/Velaptor.Content.Exceptions.CachingException.md b/docs/api/Velaptor.Content.Exceptions.CachingException.md index dd7c9cac..b28a15e2 100644 --- a/docs/api/Velaptor.Content.Exceptions.CachingException.md +++ b/docs/api/Velaptor.Content.Exceptions.CachingException.md @@ -64,4 +64,4 @@ public CachingException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.CachingMetaDataException.md b/docs/api/Velaptor.Content.Exceptions.CachingMetaDataException.md index a9085d60..946d4f23 100644 --- a/docs/api/Velaptor.Content.Exceptions.CachingMetaDataException.md +++ b/docs/api/Velaptor.Content.Exceptions.CachingMetaDataException.md @@ -64,4 +64,4 @@ public CachingMetaDataException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.FontException.md b/docs/api/Velaptor.Content.Exceptions.FontException.md index 3b3e5c5a..9d1a171f 100644 --- a/docs/api/Velaptor.Content.Exceptions.FontException.md +++ b/docs/api/Velaptor.Content.Exceptions.FontException.md @@ -64,4 +64,4 @@ public FontException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.LoadAtlasException.md b/docs/api/Velaptor.Content.Exceptions.LoadAtlasException.md index 14e6b424..c9c3e46a 100644 --- a/docs/api/Velaptor.Content.Exceptions.LoadAtlasException.md +++ b/docs/api/Velaptor.Content.Exceptions.LoadAtlasException.md @@ -64,4 +64,4 @@ public LoadAtlasException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.LoadAudioException.md b/docs/api/Velaptor.Content.Exceptions.LoadAudioException.md index d5cd5c47..fd5ce877 100644 --- a/docs/api/Velaptor.Content.Exceptions.LoadAudioException.md +++ b/docs/api/Velaptor.Content.Exceptions.LoadAudioException.md @@ -64,4 +64,4 @@ public LoadAudioException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.LoadContentException.md b/docs/api/Velaptor.Content.Exceptions.LoadContentException.md index b0d8f6cd..c6530c15 100644 --- a/docs/api/Velaptor.Content.Exceptions.LoadContentException.md +++ b/docs/api/Velaptor.Content.Exceptions.LoadContentException.md @@ -64,4 +64,4 @@ public LoadContentException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.LoadTextureException.md b/docs/api/Velaptor.Content.Exceptions.LoadTextureException.md index 5b6c2702..016385f2 100644 --- a/docs/api/Velaptor.Content.Exceptions.LoadTextureException.md +++ b/docs/api/Velaptor.Content.Exceptions.LoadTextureException.md @@ -64,4 +64,4 @@ public LoadTextureException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Content.Exceptions.md b/docs/api/Velaptor.Content.Exceptions.md index daa26999..0dc5d485 100644 --- a/docs/api/Velaptor.Content.Exceptions.md +++ b/docs/api/Velaptor.Content.Exceptions.md @@ -15,3 +15,4 @@ title: Velaptor.Content.Exceptions | [LoadAudioException](Velaptor.Content.Exceptions.LoadAudioException.md 'Velaptor.Content.Exceptions.LoadAudioException') | Thrown when there is an issue loading audio. | | [LoadContentException](Velaptor.Content.Exceptions.LoadContentException.md 'Velaptor.Content.Exceptions.LoadContentException') | Thrown when there is an issue loading content. | | [LoadTextureException](Velaptor.Content.Exceptions.LoadTextureException.md 'Velaptor.Content.Exceptions.LoadTextureException') | Thrown when there is an issue loading textures. | + diff --git a/docs/api/Velaptor.Content.Fonts.Font.md b/docs/api/Velaptor.Content.Fonts.Font.md index 9565f7c3..df05d8a7 100644 --- a/docs/api/Velaptor.Content.Fonts.Font.md +++ b/docs/api/Velaptor.Content.Fonts.Font.md @@ -30,7 +30,7 @@ Gets the font atlas texture that contains all the bitmap data for all available public Velaptor.Content.ITexture Atlas { get; set; } ``` -Implements [Atlas](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Atlas 'Velaptor.Content.Fonts.IFont.Atlas') +Implements [Atlas](Velaptor.Content.Fonts.IFont.md#atlas 'Velaptor.Content.Fonts.IFont.Atlas') #### Property Value [ITexture](Velaptor.Content.ITexture.md 'Velaptor.Content.ITexture') @@ -39,13 +39,13 @@ Implements [Atlas](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont. ### AvailableStylesForFamily -Gets a list of all the available font styles for the current font [FamilyName](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.FamilyName 'Velaptor.Content.Fonts.IFont.FamilyName'). +Gets a list of all the available font styles for the current font [FamilyName](Velaptor.Content.Fonts.IFont.md#familyname 'Velaptor.Content.Fonts.IFont.FamilyName'). ```csharp public System.Collections.Generic.IEnumerable AvailableStylesForFamily { get; } ``` -Implements [AvailableStylesForFamily](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.AvailableStylesForFamily 'Velaptor.Content.Fonts.IFont.AvailableStylesForFamily') +Implements [AvailableStylesForFamily](Velaptor.Content.Fonts.IFont.md#availablestylesforfamily 'Velaptor.Content.Fonts.IFont.AvailableStylesForFamily') #### Property Value [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[FontStyle](Velaptor.Content.Fonts.FontStyle.md 'Velaptor.Content.Fonts.FontStyle')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') @@ -60,7 +60,7 @@ Gets or sets a value indicating whether to cache the measurements of the text. public bool CacheEnabled { get; set; } ``` -Implements [CacheEnabled](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.CacheEnabled 'Velaptor.Content.Fonts.IFont.CacheEnabled') +Implements [CacheEnabled](Velaptor.Content.Fonts.IFont.md#cacheenabled 'Velaptor.Content.Fonts.IFont.CacheEnabled') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -75,7 +75,7 @@ Gets the name of the font family. public string FamilyName { get; } ``` -Implements [FamilyName](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.FamilyName 'Velaptor.Content.Fonts.IFont.FamilyName') +Implements [FamilyName](Velaptor.Content.Fonts.IFont.md#familyname 'Velaptor.Content.Fonts.IFont.FamilyName') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -90,7 +90,7 @@ Gets the path to the content. public string FilePath { get; } ``` -Implements [FilePath](Velaptor.Content.IContent.md#Velaptor.Content.IContent.FilePath 'Velaptor.Content.IContent.FilePath') +Implements [FilePath](Velaptor.Content.IContent.md#filepath 'Velaptor.Content.IContent.FilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -105,7 +105,7 @@ Gets a value indicating whether the font has kerning for text rendering layout. public bool HasKerning { get; } ``` -Implements [HasKerning](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.HasKerning 'Velaptor.Content.Fonts.IFont.HasKerning') +Implements [HasKerning](Velaptor.Content.Fonts.IFont.md#haskerning 'Velaptor.Content.Fonts.IFont.HasKerning') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -120,7 +120,7 @@ Gets a value indicating whether the font is a default font. public bool IsDefaultFont { get; } ``` -Implements [IsDefaultFont](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.IsDefaultFont 'Velaptor.Content.Fonts.IFont.IsDefaultFont') +Implements [IsDefaultFont](Velaptor.Content.Fonts.IFont.md#isdefaultfont 'Velaptor.Content.Fonts.IFont.IsDefaultFont') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -135,7 +135,7 @@ Gets the spacing between lines of text in pixels. public float LineSpacing { get; set; } ``` -Implements [LineSpacing](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.LineSpacing 'Velaptor.Content.Fonts.IFont.LineSpacing') +Implements [LineSpacing](Velaptor.Content.Fonts.IFont.md#linespacing 'Velaptor.Content.Fonts.IFont.LineSpacing') #### Property Value [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') @@ -150,7 +150,7 @@ Gets or sets the maximum number of measurements to cache. public int MaxCacheSize { get; set; } ``` -Implements [MaxCacheSize](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.MaxCacheSize 'Velaptor.Content.Fonts.IFont.MaxCacheSize') +Implements [MaxCacheSize](Velaptor.Content.Fonts.IFont.md#maxcachesize 'Velaptor.Content.Fonts.IFont.MaxCacheSize') #### Property Value [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') @@ -165,7 +165,7 @@ Gets the list of metrics for all the glyphs supported by the font. public System.Collections.Generic.IReadOnlyCollection Metrics { get; } ``` -Implements [Metrics](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Metrics 'Velaptor.Content.Fonts.IFont.Metrics') +Implements [Metrics](Velaptor.Content.Fonts.IFont.md#metrics 'Velaptor.Content.Fonts.IFont.Metrics') #### Property Value [System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1')[GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection`1') @@ -180,7 +180,7 @@ Gets the name of the content. public string Name { get; } ``` -Implements [Name](Velaptor.Content.IContent.md#Velaptor.Content.IContent.Name 'Velaptor.Content.IContent.Name') +Implements [Name](Velaptor.Content.IContent.md#name 'Velaptor.Content.IContent.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -195,7 +195,7 @@ Gets or sets the size of the font in points. public uint Size { get; set; } ``` -Implements [Size](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Size 'Velaptor.Content.Fonts.IFont.Size') +Implements [Size](Velaptor.Content.Fonts.IFont.md#size 'Velaptor.Content.Fonts.IFont.Size') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -210,7 +210,7 @@ Gets the source of where the font was loaded. public Velaptor.Content.Fonts.FontSource Source { get; } ``` -Implements [Source](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Source 'Velaptor.Content.Fonts.IFont.Source') +Implements [Source](Velaptor.Content.Fonts.IFont.md#source 'Velaptor.Content.Fonts.IFont.Source') #### Property Value [FontSource](Velaptor.Content.Fonts.FontSource.md 'Velaptor.Content.Fonts.FontSource') @@ -225,7 +225,7 @@ Gets or sets the style of the font. public Velaptor.Content.Fonts.FontStyle Style { get; set; } ``` -Implements [Style](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Style 'Velaptor.Content.Fonts.IFont.Style') +Implements [Style](Velaptor.Content.Fonts.IFont.md#style 'Velaptor.Content.Fonts.IFont.Style') #### Property Value [FontStyle](Velaptor.Content.Fonts.FontStyle.md 'Velaptor.Content.Fonts.FontStyle') @@ -235,8 +235,8 @@ Implements [Style](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont. ### GetCharacterBounds(string, Vector2) -Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.GetCharacterBounds(string,System.Numerics.Vector2).text 'Velaptor.Content.Fonts.Font.GetCharacterBounds(string, System.Numerics.Vector2).text') based on the -given [textPos](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.GetCharacterBounds(string,System.Numerics.Vector2).textPos 'Velaptor.Content.Fonts.Font.GetCharacterBounds(string, System.Numerics.Vector2).textPos'). +Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.Font.md#text 'Velaptor.Content.Fonts.Font.GetCharacterBounds(string, System.Numerics.Vector2).text') based on the +given [textPos](Velaptor.Content.Fonts.Font.md#textpos 'Velaptor.Content.Fonts.Font.GetCharacterBounds(string, System.Numerics.Vector2).textPos'). ```csharp public System.Collections.Generic.IEnumerable<(char character,System.Drawing.RectangleF bounds)> GetCharacterBounds(string text, System.Numerics.Vector2 textPos); @@ -265,8 +265,8 @@ The bounds for each character. ### GetCharacterBounds(StringBuilder, Vector2) -Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder,System.Numerics.Vector2).text 'Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).text') based on the -given [textPos](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder,System.Numerics.Vector2).textPos 'Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).textPos'). +Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.Font.md#text 'Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).text') based on the +given [textPos](Velaptor.Content.Fonts.Font.md#textpos 'Velaptor.Content.Fonts.Font.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).textPos'). ```csharp public System.Collections.Generic.IEnumerable<(char character,System.Drawing.RectangleF bounds)> GetCharacterBounds(System.Text.StringBuilder text, System.Numerics.Vector2 textPos); @@ -329,7 +329,7 @@ https://freetype.org/freetype2/docs/glyphs/glyphs-4.html#section-1. ### Measure(string) -Measures the width and height bounds of the given [text](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.Measure(string).text 'Velaptor.Content.Fonts.Font.Measure(string).text'). +Measures the width and height bounds of the given [text](Velaptor.Content.Fonts.Font.md#text 'Velaptor.Content.Fonts.Font.Measure(string).text'). ```csharp public System.Drawing.SizeF Measure(string text); @@ -369,4 +369,4 @@ Implements [ToGlyphMetrics(string)](Velaptor.Content.Fonts.IFont.md#Velaptor.Con #### Returns [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The list of glyph metrics of the given [text](Velaptor.Content.Fonts.Font.md#Velaptor.Content.Fonts.Font.ToGlyphMetrics(string).text 'Velaptor.Content.Fonts.Font.ToGlyphMetrics(string).text'). \ No newline at end of file +The list of glyph metrics of the given [text](Velaptor.Content.Fonts.Font.md#text 'Velaptor.Content.Fonts.Font.ToGlyphMetrics(string).text'). diff --git a/docs/api/Velaptor.Content.Fonts.FontSource.md b/docs/api/Velaptor.Content.Fonts.FontSource.md index 22599673..fa3475c9 100644 --- a/docs/api/Velaptor.Content.Fonts.FontSource.md +++ b/docs/api/Velaptor.Content.Fonts.FontSource.md @@ -37,4 +37,4 @@ When loading fonts, the font that is attempting to be loaded will be checked for its existence in the application's content directory first. If the font does not exist there, then the font will be checked for its existence in the system. If the font does not exist in the application's -content directory or the system, then an exception will be thrown. \ No newline at end of file +content directory or the system, then an exception will be thrown. diff --git a/docs/api/Velaptor.Content.Fonts.FontStyle.md b/docs/api/Velaptor.Content.Fonts.FontStyle.md index 9de93e09..fd9a07d5 100644 --- a/docs/api/Velaptor.Content.Fonts.FontStyle.md +++ b/docs/api/Velaptor.Content.Fonts.FontStyle.md @@ -30,4 +30,4 @@ Italic font style. `Regular` 0 -Regular font style. \ No newline at end of file +Regular font style. diff --git a/docs/api/Velaptor.Content.Fonts.IFont.md b/docs/api/Velaptor.Content.Fonts.IFont.md index 19e618f9..9d988517 100644 --- a/docs/api/Velaptor.Content.Fonts.IFont.md +++ b/docs/api/Velaptor.Content.Fonts.IFont.md @@ -37,7 +37,7 @@ Velaptor.Content.ITexture Atlas { get; } ### AvailableStylesForFamily -Gets a list of all the available font styles for the current font [FamilyName](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.FamilyName 'Velaptor.Content.Fonts.IFont.FamilyName'). +Gets a list of all the available font styles for the current font [FamilyName](Velaptor.Content.Fonts.IFont.md#familyname 'Velaptor.Content.Fonts.IFont.FamilyName'). ```csharp System.Collections.Generic.IEnumerable AvailableStylesForFamily { get; } @@ -181,8 +181,8 @@ Velaptor.Content.Fonts.FontStyle Style { get; set; } ### GetCharacterBounds(string, Vector2) -Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetCharacterBounds(string,System.Numerics.Vector2).text 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(string, System.Numerics.Vector2).text') based on the -given [textPos](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetCharacterBounds(string,System.Numerics.Vector2).textPos 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(string, System.Numerics.Vector2).textPos'). +Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.IFont.md#text 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(string, System.Numerics.Vector2).text') based on the +given [textPos](Velaptor.Content.Fonts.IFont.md#textpos 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(string, System.Numerics.Vector2).textPos'). ```csharp System.Collections.Generic.IEnumerable<(char character,System.Drawing.RectangleF bounds)> GetCharacterBounds(string text, System.Numerics.Vector2 textPos); @@ -209,8 +209,8 @@ The bounds for each character. ### GetCharacterBounds(StringBuilder, Vector2) -Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder,System.Numerics.Vector2).text 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).text') based on the -given [textPos](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder,System.Numerics.Vector2).textPos 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).textPos'). +Returns the bounds of each character in the given [text](Velaptor.Content.Fonts.IFont.md#text 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).text') based on the +given [textPos](Velaptor.Content.Fonts.IFont.md#textpos 'Velaptor.Content.Fonts.IFont.GetCharacterBounds(System.Text.StringBuilder, System.Numerics.Vector2).textPos'). ```csharp System.Collections.Generic.IEnumerable<(char character,System.Drawing.RectangleF bounds)> GetCharacterBounds(System.Text.StringBuilder text, System.Numerics.Vector2 textPos); @@ -237,7 +237,7 @@ The bounds for each character. ### GetKerning(uint, uint) -Gets the kerning between two glyphs using the given [leftGlyphIndex](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetKerning(uint,uint).leftGlyphIndex 'Velaptor.Content.Fonts.IFont.GetKerning(uint, uint).leftGlyphIndex') and [rightGlyphIndex](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.GetKerning(uint,uint).rightGlyphIndex 'Velaptor.Content.Fonts.IFont.GetKerning(uint, uint).rightGlyphIndex'). +Gets the kerning between two glyphs using the given [leftGlyphIndex](Velaptor.Content.Fonts.IFont.md#leftglyphindex 'Velaptor.Content.Fonts.IFont.GetKerning(uint, uint).leftGlyphIndex') and [rightGlyphIndex](Velaptor.Content.Fonts.IFont.md#rightglyphindex 'Velaptor.Content.Fonts.IFont.GetKerning(uint, uint).rightGlyphIndex'). ```csharp float GetKerning(uint leftGlyphIndex, uint rightGlyphIndex); @@ -267,7 +267,7 @@ Refer to https://freetype.org/freetype2/docs/glyphs/glyphs-4.html for more info. ### Measure(string) -Measures the width and height bounds of the given [text](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.Measure(string).text 'Velaptor.Content.Fonts.IFont.Measure(string).text'). +Measures the width and height bounds of the given [text](Velaptor.Content.Fonts.IFont.md#text 'Velaptor.Content.Fonts.IFont.Measure(string).text'). ```csharp System.Drawing.SizeF Measure(string text); @@ -288,7 +288,7 @@ The width and height of the text in pixels. ### ToGlyphMetrics(string) -Gets the glyph metrics using the given [text](Velaptor.Content.Fonts.IFont.md#Velaptor.Content.Fonts.IFont.ToGlyphMetrics(string).text 'Velaptor.Content.Fonts.IFont.ToGlyphMetrics(string).text'). +Gets the glyph metrics using the given [text](Velaptor.Content.Fonts.IFont.md#text 'Velaptor.Content.Fonts.IFont.ToGlyphMetrics(string).text'). ```csharp Velaptor.Graphics.GlyphMetrics[] ToGlyphMetrics(string text); @@ -303,4 +303,4 @@ The text to get the metrics for. #### Returns [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The metrics of each individual glyph/character. \ No newline at end of file +The metrics of each individual glyph/character. diff --git a/docs/api/Velaptor.Content.Fonts.md b/docs/api/Velaptor.Content.Fonts.md index 869f159b..a3a63171 100644 --- a/docs/api/Velaptor.Content.Fonts.md +++ b/docs/api/Velaptor.Content.Fonts.md @@ -18,3 +18,4 @@ title: Velaptor.Content.Fonts | :--- | :--- | | [FontSource](Velaptor.Content.Fonts.FontSource.md 'Velaptor.Content.Fonts.FontSource') | Represents the source of where a font was loaded. | | [FontStyle](Velaptor.Content.Fonts.FontStyle.md 'Velaptor.Content.Fonts.FontStyle') | The kind of font styles. | + diff --git a/docs/api/Velaptor.Content.IAtlasData.md b/docs/api/Velaptor.Content.IAtlasData.md index d245fc40..f3d9f4e6 100644 --- a/docs/api/Velaptor.Content.IAtlasData.md +++ b/docs/api/Velaptor.Content.IAtlasData.md @@ -125,4 +125,4 @@ The sub texture ID of the frames to return. #### Returns [AtlasSubTextureData](Velaptor.Graphics.AtlasSubTextureData.md 'Velaptor.Graphics.AtlasSubTextureData')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The list of frame rectangles. \ No newline at end of file +The list of frame rectangles. diff --git a/docs/api/Velaptor.Content.IAudio.md b/docs/api/Velaptor.Content.IAudio.md index 41df9c70..e446fc31 100644 --- a/docs/api/Velaptor.Content.IAudio.md +++ b/docs/api/Velaptor.Content.IAudio.md @@ -44,7 +44,7 @@ Gets the fully qualified path to the content file. string FilePath { get; } ``` -Implements [FilePath](Velaptor.Content.IContent.md#Velaptor.Content.IContent.FilePath 'Velaptor.Content.IContent.FilePath') +Implements [FilePath](Velaptor.Content.IContent.md#filepath 'Velaptor.Content.IContent.FilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -137,7 +137,7 @@ Gets the name of the content. string Name { get; } ``` -Implements [Name](Velaptor.Content.IContent.md#Velaptor.Content.IContent.Name 'Velaptor.Content.IContent.Name') +Implements [Name](Velaptor.Content.IContent.md#name 'Velaptor.Content.IContent.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -195,7 +195,7 @@ this range is used, it will be set within that range. ### FastForward(float) -Fast forwards the audio by the given amount of [seconds](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.FastForward(float).seconds 'Velaptor.Content.IAudio.FastForward(float).seconds'). +Fast forwards the audio by the given amount of [seconds](Velaptor.Content.IAudio.md#seconds 'Velaptor.Content.IAudio.FastForward(float).seconds'). ```csharp void FastForward(float seconds); @@ -232,7 +232,7 @@ void Play(); ### Rewind(float) -Rewinds the audio by the given amount of [seconds](Velaptor.Content.IAudio.md#Velaptor.Content.IAudio.Rewind(float).seconds 'Velaptor.Content.IAudio.Rewind(float).seconds'). +Rewinds the audio by the given amount of [seconds](Velaptor.Content.IAudio.md#seconds 'Velaptor.Content.IAudio.Rewind(float).seconds'). ```csharp void Rewind(float seconds); @@ -270,4 +270,4 @@ Stops the audio playback and resets back to the beginning. ```csharp void Stop(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Content.IContent.md b/docs/api/Velaptor.Content.IContent.md index c38b307b..8c3b0a6e 100644 --- a/docs/api/Velaptor.Content.IContent.md +++ b/docs/api/Velaptor.Content.IContent.md @@ -48,4 +48,4 @@ string Name { get; } ``` #### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') diff --git a/docs/api/Velaptor.Content.IContentLoadable.md b/docs/api/Velaptor.Content.IContentLoadable.md index 4f17fc0a..61b7a8cf 100644 --- a/docs/api/Velaptor.Content.IContentLoadable.md +++ b/docs/api/Velaptor.Content.IContentLoadable.md @@ -46,4 +46,4 @@ Unloads the content for an object. ```csharp void UnloadContent(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Content.IContentPathResolver.md b/docs/api/Velaptor.Content.IContentPathResolver.md index cfe05975..069232c4 100644 --- a/docs/api/Velaptor.Content.IContentPathResolver.md +++ b/docs/api/Velaptor.Content.IContentPathResolver.md @@ -30,7 +30,7 @@ string ContentDirectoryName { get; } #### Remarks This directory is not a path. It is just a name and is always located -as a child directory of the [RootDirectoryPath](Velaptor.Content.IContentPathResolver.md#Velaptor.Content.IContentPathResolver.RootDirectoryPath 'Velaptor.Content.IContentPathResolver.RootDirectoryPath'). +as a child directory of the [RootDirectoryPath](Velaptor.Content.IContentPathResolver.md#rootdirectorypath 'Velaptor.Content.IContentPathResolver.RootDirectoryPath'). If the value is a file path, the file name will be stripped and the deepest child directory name will be used. @@ -67,7 +67,7 @@ The directory only path to some content. ### ResolveFilePath(string) -Resolves the full file path to a content item that matches the given [contentPathOrName](Velaptor.Content.IContentPathResolver.md#Velaptor.Content.IContentPathResolver.ResolveFilePath(string).contentPathOrName 'Velaptor.Content.IContentPathResolver.ResolveFilePath(string).contentPathOrName'). +Resolves the full file path to a content item that matches the given [contentPathOrName](Velaptor.Content.IContentPathResolver.md#contentpathorname 'Velaptor.Content.IContentPathResolver.ResolveFilePath(string).contentPathOrName'). ```csharp string ResolveFilePath(string contentPathOrName); @@ -82,4 +82,4 @@ The name of the content item with or without the file extension. #### Returns [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The [RootDirectoryPath](Velaptor.Content.IContentPathResolver.md#Velaptor.Content.IContentPathResolver.RootDirectoryPath 'Velaptor.Content.IContentPathResolver.RootDirectoryPath'), content file name, and the [ContentDirectoryName](Velaptor.Content.IContentPathResolver.md#Velaptor.Content.IContentPathResolver.ContentDirectoryName 'Velaptor.Content.IContentPathResolver.ContentDirectoryName') combined. \ No newline at end of file +The [RootDirectoryPath](Velaptor.Content.IContentPathResolver.md#rootdirectorypath 'Velaptor.Content.IContentPathResolver.RootDirectoryPath'), content file name, and the [ContentDirectoryName](Velaptor.Content.IContentPathResolver.md#contentdirectoryname 'Velaptor.Content.IContentPathResolver.ContentDirectoryName') combined. diff --git a/docs/api/Velaptor.Content.ILoader_T_.md b/docs/api/Velaptor.Content.ILoader_T_.md index 3af5af7f..c29c9345 100644 --- a/docs/api/Velaptor.Content.ILoader_T_.md +++ b/docs/api/Velaptor.Content.ILoader_T_.md @@ -7,7 +7,7 @@ title: Velaptor.Content.ILoader #### ILoader<T> Interface -Loads data of type [T](Velaptor.Content.ILoader_T_.md#Velaptor.Content.ILoader_T_.T 'Velaptor.Content.ILoader.T'). +Loads data of type [T](Velaptor.Content.ILoader_T_.md#t 'Velaptor.Content.ILoader.T'). ```csharp public interface ILoader @@ -26,7 +26,7 @@ The type of data to load. ### Unload(string) -Unloads the data with the given [contentPathOrName](Velaptor.Content.ILoader_T_.md#Velaptor.Content.ILoader_T_.Unload(string).contentPathOrName 'Velaptor.Content.ILoader.Unload(string).contentPathOrName'). +Unloads the data with the given [contentPathOrName](Velaptor.Content.ILoader_T_.md#contentpathorname 'Velaptor.Content.ILoader.Unload(string).contentPathOrName'). ```csharp void Unload(string contentPathOrName); @@ -37,4 +37,4 @@ void Unload(string contentPathOrName); `contentPathOrName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The name of the content item to unload. \ No newline at end of file +The name of the content item to unload. diff --git a/docs/api/Velaptor.Content.ITexture.md b/docs/api/Velaptor.Content.ITexture.md index 81c43ad8..3eeae9f0 100644 --- a/docs/api/Velaptor.Content.ITexture.md +++ b/docs/api/Velaptor.Content.ITexture.md @@ -57,4 +57,4 @@ uint Width { get; } ``` #### Property Value -[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') \ No newline at end of file +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') diff --git a/docs/api/Velaptor.Content.Texture.md b/docs/api/Velaptor.Content.Texture.md index 685072fb..2e94831b 100644 --- a/docs/api/Velaptor.Content.Texture.md +++ b/docs/api/Velaptor.Content.Texture.md @@ -30,7 +30,7 @@ Gets the path to the content. public string FilePath { get; } ``` -Implements [FilePath](Velaptor.Content.IContent.md#Velaptor.Content.IContent.FilePath 'Velaptor.Content.IContent.FilePath') +Implements [FilePath](Velaptor.Content.IContent.md#filepath 'Velaptor.Content.IContent.FilePath') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -45,7 +45,7 @@ Gets the height of the texture. public uint Height { get; set; } ``` -Implements [Height](Velaptor.Content.ITexture.md#Velaptor.Content.ITexture.Height 'Velaptor.Content.ITexture.Height') +Implements [Height](Velaptor.Content.ITexture.md#height 'Velaptor.Content.ITexture.Height') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -60,7 +60,7 @@ Gets the ID of the texture. public uint Id { get; set; } ``` -Implements [Id](Velaptor.Content.ITexture.md#Velaptor.Content.ITexture.Id 'Velaptor.Content.ITexture.Id') +Implements [Id](Velaptor.Content.ITexture.md#id 'Velaptor.Content.ITexture.Id') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -75,7 +75,7 @@ Gets the name of the content. public string Name { get; set; } ``` -Implements [Name](Velaptor.Content.IContent.md#Velaptor.Content.IContent.Name 'Velaptor.Content.IContent.Name') +Implements [Name](Velaptor.Content.IContent.md#name 'Velaptor.Content.IContent.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -90,7 +90,7 @@ Gets the width of the texture. public uint Width { get; set; } ``` -Implements [Width](Velaptor.Content.ITexture.md#Velaptor.Content.ITexture.Width 'Velaptor.Content.ITexture.Width') +Implements [Width](Velaptor.Content.ITexture.md#width 'Velaptor.Content.ITexture.Width') #### Property Value -[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') \ No newline at end of file +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') diff --git a/docs/api/Velaptor.Content.md b/docs/api/Velaptor.Content.md index 07ae102e..18793ff9 100644 --- a/docs/api/Velaptor.Content.md +++ b/docs/api/Velaptor.Content.md @@ -19,9 +19,10 @@ title: Velaptor.Content | [IContent](Velaptor.Content.IContent.md 'Velaptor.Content.IContent') | Represents loadable content data. | | [IContentLoadable](Velaptor.Content.IContentLoadable.md 'Velaptor.Content.IContentLoadable') | Provides the ability to load content. | | [IContentPathResolver](Velaptor.Content.IContentPathResolver.md 'Velaptor.Content.IContentPathResolver') | Resolves file paths. | -| [ILoader<T>](Velaptor.Content.ILoader_T_.md 'Velaptor.Content.ILoader') | Loads data of type [T](Velaptor.Content.ILoader_T_.md#Velaptor.Content.ILoader_T_.T 'Velaptor.Content.ILoader.T'). | +| [ILoader<T>](Velaptor.Content.ILoader_T_.md 'Velaptor.Content.ILoader') | Loads data of type [T](Velaptor.Content.ILoader_T_.md#t 'Velaptor.Content.ILoader.T'). | | [ITexture](Velaptor.Content.ITexture.md 'Velaptor.Content.ITexture') | The texture to render to a screen. | | Enums | | | :--- | :--- | | [AudioBuffer](Velaptor.Content.AudioBuffer.md 'Velaptor.Content.AudioBuffer') | The kinds of buffering used for audio. | + diff --git a/docs/api/Velaptor.Exceptions.AppSettingsException.md b/docs/api/Velaptor.Exceptions.AppSettingsException.md index 86a47acb..c46488bd 100644 --- a/docs/api/Velaptor.Exceptions.AppSettingsException.md +++ b/docs/api/Velaptor.Exceptions.AppSettingsException.md @@ -64,4 +64,4 @@ public AppSettingsException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.AtlasException.md b/docs/api/Velaptor.Exceptions.AtlasException.md index 3804f605..ef4f264a 100644 --- a/docs/api/Velaptor.Exceptions.AtlasException.md +++ b/docs/api/Velaptor.Exceptions.AtlasException.md @@ -64,4 +64,4 @@ public AtlasException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.InvalidRenderEffectsException.md b/docs/api/Velaptor.Exceptions.InvalidRenderEffectsException.md index abbe0819..84f8b426 100644 --- a/docs/api/Velaptor.Exceptions.InvalidRenderEffectsException.md +++ b/docs/api/Velaptor.Exceptions.InvalidRenderEffectsException.md @@ -64,4 +64,4 @@ public InvalidRenderEffectsException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.LoadEmbeddedResourceException.md b/docs/api/Velaptor.Exceptions.LoadEmbeddedResourceException.md index 012b0fbf..2aaaad6e 100644 --- a/docs/api/Velaptor.Exceptions.LoadEmbeddedResourceException.md +++ b/docs/api/Velaptor.Exceptions.LoadEmbeddedResourceException.md @@ -64,4 +64,4 @@ public LoadEmbeddedResourceException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The exception message. \ No newline at end of file +The exception message. diff --git a/docs/api/Velaptor.Exceptions.PushNotificationException.md b/docs/api/Velaptor.Exceptions.PushNotificationException.md index b7d7820c..919a8a57 100644 --- a/docs/api/Velaptor.Exceptions.PushNotificationException.md +++ b/docs/api/Velaptor.Exceptions.PushNotificationException.md @@ -87,4 +87,4 @@ public PushNotificationException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.SceneAlreadyExistsException.md b/docs/api/Velaptor.Exceptions.SceneAlreadyExistsException.md index 00f36876..7d9b158f 100644 --- a/docs/api/Velaptor.Exceptions.SceneAlreadyExistsException.md +++ b/docs/api/Velaptor.Exceptions.SceneAlreadyExistsException.md @@ -87,4 +87,4 @@ public SceneAlreadyExistsException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.SystemDisplayException.md b/docs/api/Velaptor.Exceptions.SystemDisplayException.md index 9fda6cc6..04c7711d 100644 --- a/docs/api/Velaptor.Exceptions.SystemDisplayException.md +++ b/docs/api/Velaptor.Exceptions.SystemDisplayException.md @@ -64,4 +64,4 @@ public SystemDisplayException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Exceptions.md b/docs/api/Velaptor.Exceptions.md index cd223c21..25b48115 100644 --- a/docs/api/Velaptor.Exceptions.md +++ b/docs/api/Velaptor.Exceptions.md @@ -15,3 +15,4 @@ title: Velaptor.Exceptions | [PushNotificationException](Velaptor.Exceptions.PushNotificationException.md 'Velaptor.Exceptions.PushNotificationException') | Thrown when there is an issue with the push notification system. | | [SceneAlreadyExistsException](Velaptor.Exceptions.SceneAlreadyExistsException.md 'Velaptor.Exceptions.SceneAlreadyExistsException') | Thrown when a scene already exists. | | [SystemDisplayException](Velaptor.Exceptions.SystemDisplayException.md 'Velaptor.Exceptions.SystemDisplayException') | Occurs when there is an issue with one of the system displays. | + diff --git a/docs/api/Velaptor.ExtensionMethods.ContentExtensions.md b/docs/api/Velaptor.ExtensionMethods.ContentExtensions.md index 0c62d6bb..a176e4c8 100644 --- a/docs/api/Velaptor.ExtensionMethods.ContentExtensions.md +++ b/docs/api/Velaptor.ExtensionMethods.ContentExtensions.md @@ -52,7 +52,7 @@ The loaded font. #### Exceptions [System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -Occurs when the [fontName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.Fonts.IFont_,string,uint).fontName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string, uint).fontName') argument is null or empty. +Occurs when the [fontName](Velaptor.ExtensionMethods.ContentExtensions.md#fontname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string, uint).fontName') argument is null or empty. [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. @@ -66,7 +66,7 @@ Directory paths are not valid. ### Load(this ILoader<IAtlasData>, string) -Loads texture atlas data using the given [atlasPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.IAtlasData_,string).atlasPathOrName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).atlasPathOrName'). +Loads texture atlas data using the given [atlasPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#atlaspathorname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).atlasPathOrName'). ```csharp public static Velaptor.Content.IAtlasData Load(this Velaptor.Content.ILoader loader, string atlasPathOrName); @@ -92,7 +92,7 @@ The loaded atlas data. #### Exceptions [System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -Thrown if the [atlasPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.IAtlasData_,string).atlasPathOrName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).atlasPathOrName') is null or empty. +Thrown if the [atlasPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#atlaspathorname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).atlasPathOrName') is null or empty. [LoadTextureException](Velaptor.Content.Exceptions.LoadTextureException.md 'Velaptor.Content.Exceptions.LoadTextureException') Thrown if the resulting texture content file path is invalid. @@ -161,7 +161,7 @@ The loaded audio. #### Exceptions [System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -Thrown if the [audioPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.IAudio_,string,Velaptor.Content.AudioBuffer).audioPathOrName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string, Velaptor.Content.AudioBuffer).audioPathOrName') is null or empty. +Thrown if the [audioPathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#audiopathorname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string, Velaptor.Content.AudioBuffer).audioPathOrName') is null or empty. [LoadTextureException](Velaptor.Content.Exceptions.LoadTextureException.md 'Velaptor.Content.Exceptions.LoadTextureException') Thrown if the resulting texture content file path is invalid. @@ -188,7 +188,7 @@ The path contains a colon character `:` that is not part of a drive label. ### Load(this ILoader<ITexture>, string) -Loads a texture with the given [texturePathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.ITexture_,string).texturePathOrName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).texturePathOrName'). +Loads a texture with the given [texturePathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#texturepathorname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).texturePathOrName'). ```csharp public static Velaptor.Content.ITexture Load(this Velaptor.Content.ILoader loader, string texturePathOrName); @@ -214,7 +214,7 @@ The loaded texture. #### Exceptions [System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -Thrown if the [texturePathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Load(thisVelaptor.Content.ILoader_Velaptor.Content.ITexture_,string).texturePathOrName 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).texturePathOrName') is null or empty. +Thrown if the [texturePathOrName](Velaptor.ExtensionMethods.ContentExtensions.md#texturepathorname 'Velaptor.ExtensionMethods.ContentExtensions.Load(this Velaptor.Content.ILoader, string).texturePathOrName') is null or empty. [LoadTextureException](Velaptor.Content.Exceptions.LoadTextureException.md 'Velaptor.Content.Exceptions.LoadTextureException') Thrown if the resulting texture content file path is invalid. @@ -241,7 +241,7 @@ The path contains a colon character `:` that is not part of a drive label. ### Unload(this ILoader<IFont>, IFont) -Unloads the given [font](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Unload(thisVelaptor.Content.ILoader_Velaptor.Content.Fonts.IFont_,Velaptor.Content.Fonts.IFont).font 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.Fonts.IFont).font'). +Unloads the given [font](Velaptor.ExtensionMethods.ContentExtensions.md#font 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.Fonts.IFont).font'). ```csharp public static void Unload(this Velaptor.Content.ILoader loader, Velaptor.Content.Fonts.IFont? font); @@ -264,7 +264,7 @@ The content to unload. ### Unload(this ILoader<IAtlasData>, IAtlasData) -Unloads the given [atlas](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Unload(thisVelaptor.Content.ILoader_Velaptor.Content.IAtlasData_,Velaptor.Content.IAtlasData).atlas 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.IAtlasData).atlas'). +Unloads the given [atlas](Velaptor.ExtensionMethods.ContentExtensions.md#atlas 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.IAtlasData).atlas'). ```csharp public static void Unload(this Velaptor.Content.ILoader loader, Velaptor.Content.IAtlasData? atlas); @@ -287,7 +287,7 @@ The content to unload. ### Unload(this ILoader<IAudio>, IAudio) -Unloads the given [audio](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Unload(thisVelaptor.Content.ILoader_Velaptor.Content.IAudio_,Velaptor.Content.IAudio).audio 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.IAudio).audio'). +Unloads the given [audio](Velaptor.ExtensionMethods.ContentExtensions.md#audio 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.IAudio).audio'). ```csharp public static void Unload(this Velaptor.Content.ILoader loader, Velaptor.Content.IAudio? audio); @@ -310,7 +310,7 @@ The content to unload. ### Unload(this ILoader<ITexture>, ITexture) -Unloads the given [texture](Velaptor.ExtensionMethods.ContentExtensions.md#Velaptor.ExtensionMethods.ContentExtensions.Unload(thisVelaptor.Content.ILoader_Velaptor.Content.ITexture_,Velaptor.Content.ITexture).texture 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.ITexture).texture'). +Unloads the given [texture](Velaptor.ExtensionMethods.ContentExtensions.md#texture 'Velaptor.ExtensionMethods.ContentExtensions.Unload(this Velaptor.Content.ILoader, Velaptor.Content.ITexture).texture'). ```csharp public static void Unload(this Velaptor.Content.ILoader loader, Velaptor.Content.ITexture? texture); @@ -327,4 +327,4 @@ The loader. `texture` [ITexture](Velaptor.Content.ITexture.md 'Velaptor.Content.ITexture') -The content to unload. \ No newline at end of file +The content to unload. diff --git a/docs/api/Velaptor.ExtensionMethods.md b/docs/api/Velaptor.ExtensionMethods.md index 81a781d0..84c8db0f 100644 --- a/docs/api/Velaptor.ExtensionMethods.md +++ b/docs/api/Velaptor.ExtensionMethods.md @@ -9,3 +9,4 @@ title: Velaptor.ExtensionMethods | Classes | | | :--- | :--- | | [ContentExtensions](Velaptor.ExtensionMethods.ContentExtensions.md 'Velaptor.ExtensionMethods.ContentExtensions') | Provides content related extension methods. | + diff --git a/docs/api/Velaptor.Factories.ContentLoaderFactory.md b/docs/api/Velaptor.Factories.ContentLoaderFactory.md index a11041b0..c452f20b 100644 --- a/docs/api/Velaptor.Factories.ContentLoaderFactory.md +++ b/docs/api/Velaptor.Factories.ContentLoaderFactory.md @@ -70,4 +70,4 @@ public static Velaptor.Content.ILoader CreateTextureL #### Returns [Velaptor.Content.ILoader<](Velaptor.Content.ILoader_T_.md 'Velaptor.Content.ILoader')[ITexture](Velaptor.Content.ITexture.md 'Velaptor.Content.ITexture')[>](Velaptor.Content.ILoader_T_.md 'Velaptor.Content.ILoader') -A loader for loading textures. \ No newline at end of file +A loader for loading textures. diff --git a/docs/api/Velaptor.Factories.HardwareFactory.md b/docs/api/Velaptor.Factories.HardwareFactory.md index 126e205b..fd9d5fe5 100644 --- a/docs/api/Velaptor.Factories.HardwareFactory.md +++ b/docs/api/Velaptor.Factories.HardwareFactory.md @@ -70,4 +70,4 @@ public static Velaptor.Input.IAppInput GetMouse(); #### Returns [Velaptor.Input.IAppInput<](Velaptor.Input.IAppInput_TState_.md 'Velaptor.Input.IAppInput')[MouseState](Velaptor.Input.MouseState.md 'Velaptor.Input.MouseState')[>](Velaptor.Input.IAppInput_TState_.md 'Velaptor.Input.IAppInput') -The keyboard singleton object. \ No newline at end of file +The keyboard singleton object. diff --git a/docs/api/Velaptor.Factories.PathResolverFactory.md b/docs/api/Velaptor.Factories.PathResolverFactory.md index 1dcf8ce5..0db14be0 100644 --- a/docs/api/Velaptor.Factories.PathResolverFactory.md +++ b/docs/api/Velaptor.Factories.PathResolverFactory.md @@ -70,4 +70,4 @@ public static Velaptor.Content.IContentPathResolver CreateTexturePathResolver(); #### Returns [IContentPathResolver](Velaptor.Content.IContentPathResolver.md 'Velaptor.Content.IContentPathResolver') -The resolver to texture content. \ No newline at end of file +The resolver to texture content. diff --git a/docs/api/Velaptor.Factories.RendererFactory.md b/docs/api/Velaptor.Factories.RendererFactory.md index f0fdd0bd..3f53efe5 100644 --- a/docs/api/Velaptor.Factories.RendererFactory.md +++ b/docs/api/Velaptor.Factories.RendererFactory.md @@ -84,4 +84,4 @@ public static Velaptor.Graphics.Renderers.ITextureRenderer CreateTextureRenderer #### Returns [ITextureRenderer](Velaptor.Graphics.Renderers.ITextureRenderer.md 'Velaptor.Graphics.Renderers.ITextureRenderer') -The texture renderer. \ No newline at end of file +The texture renderer. diff --git a/docs/api/Velaptor.Factories.md b/docs/api/Velaptor.Factories.md index a30995b2..c98929b8 100644 --- a/docs/api/Velaptor.Factories.md +++ b/docs/api/Velaptor.Factories.md @@ -12,3 +12,4 @@ title: Velaptor.Factories | [HardwareFactory](Velaptor.Factories.HardwareFactory.md 'Velaptor.Factories.HardwareFactory') | Generates input type objects for processing input such as the keyboard and mouse. | | [PathResolverFactory](Velaptor.Factories.PathResolverFactory.md 'Velaptor.Factories.PathResolverFactory') | Creates path resolver instances. | | [RendererFactory](Velaptor.Factories.RendererFactory.md 'Velaptor.Factories.RendererFactory') | Creates renderers for rendering different types of graphics. | + diff --git a/docs/api/Velaptor.FrameTime.md b/docs/api/Velaptor.FrameTime.md index 8e98152a..5966a0c1 100644 --- a/docs/api/Velaptor.FrameTime.md +++ b/docs/api/Velaptor.FrameTime.md @@ -41,4 +41,4 @@ public System.TimeSpan TotalTime { get; set; } ``` #### Property Value -[System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan') \ No newline at end of file +[System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan') diff --git a/docs/api/Velaptor.GameHelpers.md b/docs/api/Velaptor.GameHelpers.md index a5abb1aa..5dc98fa5 100644 --- a/docs/api/Velaptor.GameHelpers.md +++ b/docs/api/Velaptor.GameHelpers.md @@ -20,7 +20,7 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O ### ApplySize(this float, float) -Returns the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisfloat,float).value 'Velaptor.GameHelpers.ApplySize(this float, float).value') with the given [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisfloat,float).size 'Velaptor.GameHelpers.ApplySize(this float, float).size') applied. +Returns the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this float, float).value') with the given [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this float, float).size') applied. ```csharp public static float ApplySize(this float value, float size); @@ -47,15 +47,15 @@ The value after the size has been applied. If the value was 3 and the size was 2, then the result would be 6. #### Remarks -A [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisfloat,float).size 'Velaptor.GameHelpers.ApplySize(this float, float).size') value of 1 represents 100% or the unchanged normal size of the value. -If the value of [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisfloat,float).size 'Velaptor.GameHelpers.ApplySize(this float, float).size') is 2, then the result would be the given -[value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisfloat,float).value 'Velaptor.GameHelpers.ApplySize(this float, float).value') that is doubled. +A [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this float, float).size') value of 1 represents 100% or the unchanged normal size of the value. +If the value of [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this float, float).size') is 2, then the result would be the given +[value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this float, float).value') that is doubled. ### ApplySize(this RectangleF, float) -Returns the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisSystem.Drawing.RectangleF,float).value 'Velaptor.GameHelpers.ApplySize(this System.Drawing.RectangleF, float).value') with the given [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisSystem.Drawing.RectangleF,float).size 'Velaptor.GameHelpers.ApplySize(this System.Drawing.RectangleF, float).size') applied. +Returns the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this System.Drawing.RectangleF, float).value') with the given [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this System.Drawing.RectangleF, float).size') applied. ```csharp public static System.Drawing.RectangleF ApplySize(this System.Drawing.RectangleF value, float size); @@ -89,7 +89,7 @@ The size will be applied to the following: ### ApplySize(this SizeF, float) -Returns the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisSystem.Drawing.SizeF,float).value 'Velaptor.GameHelpers.ApplySize(this System.Drawing.SizeF, float).value') with the given [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisSystem.Drawing.SizeF,float).size 'Velaptor.GameHelpers.ApplySize(this System.Drawing.SizeF, float).size') applied. +Returns the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this System.Drawing.SizeF, float).value') with the given [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this System.Drawing.SizeF, float).size') applied. ```csharp public static System.Drawing.SizeF ApplySize(this System.Drawing.SizeF value, float size); @@ -121,7 +121,7 @@ The size will be applied to the following: ### ApplySize(this uint, float) -Returns the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisuint,float).value 'Velaptor.GameHelpers.ApplySize(this uint, float).value') with the given [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisuint,float).size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') applied. +Returns the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this uint, float).value') with the given [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') applied. ```csharp public static float ApplySize(this uint value, float size); @@ -148,15 +148,15 @@ The value after the size has been applied. If the value was 3 and the size was 2, then the result would be 6. #### Remarks -A [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisuint,float).size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') value of 1 represents 100% or the unchanged normal size of the value. -If the value of [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisuint,float).size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') is 2, then the result would be the given -[value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisuint,float).value 'Velaptor.GameHelpers.ApplySize(this uint, float).value') that is doubled. +A [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') value of 1 represents 100% or the unchanged normal size of the value. +If the value of [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this uint, float).size') is 2, then the result would be the given +[value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this uint, float).value') that is doubled. ### ApplySize(this GlyphMetrics, float) -Returns the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisVelaptor.Graphics.GlyphMetrics,float).value 'Velaptor.GameHelpers.ApplySize(this Velaptor.Graphics.GlyphMetrics, float).value') with the given [size](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ApplySize(thisVelaptor.Graphics.GlyphMetrics,float).size 'Velaptor.GameHelpers.ApplySize(this Velaptor.Graphics.GlyphMetrics, float).size') applied. +Returns the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.ApplySize(this Velaptor.Graphics.GlyphMetrics, float).value') with the given [size](Velaptor.GameHelpers.md#size 'Velaptor.GameHelpers.ApplySize(this Velaptor.Graphics.GlyphMetrics, float).size') applied. ```csharp public static Velaptor.Graphics.GlyphMetrics ApplySize(this Velaptor.Graphics.GlyphMetrics value, float size); @@ -181,28 +181,28 @@ The result after the size has been applied. #### Remarks The size will be applied to the following: -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphBounds](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.GlyphBounds 'Velaptor.Graphics.GlyphMetrics.GlyphBounds') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Ascender](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.Ascender 'Velaptor.Graphics.GlyphMetrics.Ascender') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Descender](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.Descender 'Velaptor.Graphics.GlyphMetrics.Descender') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HorizontalAdvance](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.HorizontalAdvance 'Velaptor.Graphics.GlyphMetrics.HorizontalAdvance') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HoriBearingX](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.HoriBearingX 'Velaptor.Graphics.GlyphMetrics.HoriBearingX') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HoriBearingY](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.HoriBearingY 'Velaptor.Graphics.GlyphMetrics.HoriBearingY') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphWidth](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.GlyphWidth 'Velaptor.Graphics.GlyphMetrics.GlyphWidth') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphHeight](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.GlyphHeight 'Velaptor.Graphics.GlyphMetrics.GlyphHeight') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[XMin](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.XMin 'Velaptor.Graphics.GlyphMetrics.XMin') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[XMax](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.XMax 'Velaptor.Graphics.GlyphMetrics.XMax') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[YMin](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.YMin 'Velaptor.Graphics.GlyphMetrics.YMin') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[YMax](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.YMax 'Velaptor.Graphics.GlyphMetrics.YMax') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphBounds](Velaptor.Graphics.GlyphMetrics.md#glyphbounds 'Velaptor.Graphics.GlyphMetrics.GlyphBounds') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Ascender](Velaptor.Graphics.GlyphMetrics.md#ascender 'Velaptor.Graphics.GlyphMetrics.Ascender') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Descender](Velaptor.Graphics.GlyphMetrics.md#descender 'Velaptor.Graphics.GlyphMetrics.Descender') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HorizontalAdvance](Velaptor.Graphics.GlyphMetrics.md#horizontaladvance 'Velaptor.Graphics.GlyphMetrics.HorizontalAdvance') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HoriBearingX](Velaptor.Graphics.GlyphMetrics.md#horibearingx 'Velaptor.Graphics.GlyphMetrics.HoriBearingX') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[HoriBearingY](Velaptor.Graphics.GlyphMetrics.md#horibearingy 'Velaptor.Graphics.GlyphMetrics.HoriBearingY') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphWidth](Velaptor.Graphics.GlyphMetrics.md#glyphwidth 'Velaptor.Graphics.GlyphMetrics.GlyphWidth') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[GlyphHeight](Velaptor.Graphics.GlyphMetrics.md#glyphheight 'Velaptor.Graphics.GlyphMetrics.GlyphHeight') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[XMin](Velaptor.Graphics.GlyphMetrics.md#xmin 'Velaptor.Graphics.GlyphMetrics.XMin') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[XMax](Velaptor.Graphics.GlyphMetrics.md#xmax 'Velaptor.Graphics.GlyphMetrics.XMax') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[YMin](Velaptor.Graphics.GlyphMetrics.md#ymin 'Velaptor.Graphics.GlyphMetrics.YMin') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[YMax](Velaptor.Graphics.GlyphMetrics.md#ymax 'Velaptor.Graphics.GlyphMetrics.YMax') The size will NOT be applied to the following: -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Glyph](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.Glyph 'Velaptor.Graphics.GlyphMetrics.Glyph') -- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[CharIndex](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.CharIndex 'Velaptor.Graphics.GlyphMetrics.CharIndex') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[Glyph](Velaptor.Graphics.GlyphMetrics.md#glyph 'Velaptor.Graphics.GlyphMetrics.Glyph') +- [GlyphMetrics](Velaptor.Graphics.GlyphMetrics.md 'Velaptor.Graphics.GlyphMetrics').[CharIndex](Velaptor.Graphics.GlyphMetrics.md#charindex 'Velaptor.Graphics.GlyphMetrics.CharIndex') ### DecreaseBrightness(this Color, float) -Decreases the brightness of the color using the given [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.DecreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value. +Decreases the brightness of the color using the given [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value. ```csharp public static System.Drawing.Color DecreaseBrightness(this System.Drawing.Color clr, float brightness); @@ -243,12 +243,12 @@ In the example above, the values would equal the results below: #### Remarks -The [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.DecreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value must be a value between 0.0 and 1.0. +The [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value must be a value between 0.0 and 1.0. If a value lower than 0.0 or greater than 1.0, the brightness will automatically be adjusted within the range of 0.0 to 1.0. -Think of the [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.DecreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value as a percentage between 0% and 100%. +Think of the [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.DecreaseBrightness(this System.Drawing.Color, float).brightness') value as a percentage between 0% and 100%. The [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color').[System.Drawing.Color.A](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color.A 'System.Drawing.Color.A') color component is not effected. @@ -267,7 +267,7 @@ public static bool DoesNotContain(this string stringToSearchIn, char value); `stringToSearchIn` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The string to search that may or may not contain the [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.DoesNotContain(thisstring,char).value 'Velaptor.GameHelpers.DoesNotContain(this string, char).value'). +The string to search that may or may not contain the [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.DoesNotContain(this string, char).value'). @@ -294,7 +294,7 @@ public static bool DoesNotContain(this string stringToSearchIn, string value); `stringToSearchIn` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The string to search that may or may not contain the [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.DoesNotContain(thisstring,string).value 'Velaptor.GameHelpers.DoesNotContain(this string, string).value'). +The string to search that may or may not contain the [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.DoesNotContain(this string, string).value'). @@ -373,7 +373,7 @@ The value as a positive number. ### GetPosition(this RectangleF) -Returns the position in the given [rect](Velaptor.GameHelpers.md#Velaptor.GameHelpers.GetPosition(thisSystem.Drawing.RectangleF).rect 'Velaptor.GameHelpers.GetPosition(this System.Drawing.RectangleF).rect') as a [System.Numerics.Vector2](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector2 'System.Numerics.Vector2'). +Returns the position in the given [rect](Velaptor.GameHelpers.md#rect 'Velaptor.GameHelpers.GetPosition(this System.Drawing.RectangleF).rect') as a [System.Numerics.Vector2](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector2 'System.Numerics.Vector2'). ```csharp public static System.Numerics.Vector2 GetPosition(this System.Drawing.RectangleF rect); @@ -394,7 +394,7 @@ The [System.Drawing.RectangleF](https://docs.microsoft.com/en-us/dotnet/api/Syst ### IncreaseBrightness(this Color, float) -Increases the brightness of the color using the given [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.IncreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value. +Increases the brightness of the color using the given [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value. ```csharp public static System.Drawing.Color IncreaseBrightness(this System.Drawing.Color clr, float brightness); @@ -435,12 +435,12 @@ In the example above, the values would equal the results below: #### Remarks -The [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.IncreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value must be a value between 0.0 and 1.0. +The [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value must be a value between 0.0 and 1.0. If a value lower than 0.0 or greater than 1.0, the brightness will automatically be adjusted within the range of 0.0 to 1.0. -Think of the [brightness](Velaptor.GameHelpers.md#Velaptor.GameHelpers.IncreaseBrightness(thisSystem.Drawing.Color,float).brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value as a percentage between 0% and 100%. +Think of the [brightness](Velaptor.GameHelpers.md#brightness 'Velaptor.GameHelpers.IncreaseBrightness(this System.Drawing.Color, float).brightness') value as a percentage between 0% and 100%. The [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color').[System.Drawing.Color.A](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color.A 'System.Drawing.Color.A') color component is not effected. @@ -490,7 +490,7 @@ True if the character is not an upper or lower case letter. ### MapValue(this byte, byte, byte, byte, byte) -Maps the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,byte,byte,byte,byte).value 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).value') from one range to another. +Maps the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).value') from one range to another. ```csharp public static byte MapValue(this byte value, byte fromStart, byte fromStop, byte toStart, byte toStop); @@ -529,7 +529,7 @@ The ending value of the end range. #### Returns [System.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System.Byte') -A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,byte,byte,byte,byte).toStart 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).toStart') and [toStop](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,byte,byte,byte,byte).toStop 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).toStop'). +A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#tostart 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).toStart') and [toStop](Velaptor.GameHelpers.md#tostop 'Velaptor.GameHelpers.MapValue(this byte, byte, byte, byte, byte).toStop'). #### Remarks Be careful when restricting the 'to' values to a value between 0 and 1. This will always return a value @@ -543,7 +543,7 @@ is between the values of 0 and 1, use the method overload [MapValue(this int, fl ### MapValue(this byte, float, float, float, float) -Maps the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,float,float,float,float).value 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).value') from one range to another. +Maps the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).value') from one range to another. ```csharp public static float MapValue(this byte value, float fromStart, float fromStop, float toStart, float toStop); @@ -582,13 +582,13 @@ The ending value of the end range. #### Returns [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') -A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,float,float,float,float).toStart 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisbyte,float,float,float,float).toStop 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).toStop'). +A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#tostart 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#tostop 'Velaptor.GameHelpers.MapValue(this byte, float, float, float, float).toStop'). ### MapValue(this float, float, float, float, float) -Maps the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisfloat,float,float,float,float).value 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).value') from one range to another. +Maps the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).value') from one range to another. ```csharp public static float MapValue(this float value, float fromStart, float fromStop, float toStart, float toStop); @@ -627,13 +627,13 @@ The ending value of the end range. #### Returns [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') -A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisfloat,float,float,float,float).toStart 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisfloat,float,float,float,float).toStop 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).toStop'). +A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#tostart 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#tostop 'Velaptor.GameHelpers.MapValue(this float, float, float, float, float).toStop'). ### MapValue(this int, float, float, float, float) -Maps the given [value](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisint,float,float,float,float).value 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).value') from one range to another. +Maps the given [value](Velaptor.GameHelpers.md#value 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).value') from one range to another. ```csharp public static float MapValue(this int value, float fromStart, float fromStop, float toStart, float toStop); @@ -672,7 +672,7 @@ The ending value of the end range. #### Returns [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') -A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisint,float,float,float,float).toStart 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#Velaptor.GameHelpers.MapValue(thisint,float,float,float,float).toStop 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).toStop'). +A value that has been mapped to a range between [toStart](Velaptor.GameHelpers.md#tostart 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).toStart') and [toStop](Velaptor.GameHelpers.md#tostop 'Velaptor.GameHelpers.MapValue(this int, float, float, float, float).toStop'). @@ -699,7 +699,7 @@ The string to check. ### RotateAround(this Vector2, Vector2, float, bool) -Rotates the [vector](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') around the [origin](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin') at the given [angle](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).angle 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).angle'). +Rotates the [vector](Velaptor.GameHelpers.md#vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') around the [origin](Velaptor.GameHelpers.md#origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin') at the given [angle](Velaptor.GameHelpers.md#angle 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).angle'). ```csharp public static System.Numerics.Vector2 RotateAround(this System.Numerics.Vector2 vector, System.Numerics.Vector2 origin, float angle, bool clockWise=true); @@ -716,29 +716,29 @@ The vector to rotate. `origin` [System.Numerics.Vector2](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector2 'System.Numerics.Vector2') -The origin to rotate the [vector](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') around. +The origin to rotate the [vector](Velaptor.GameHelpers.md#vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') around. `angle` [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') -The angle in degrees to rotate [vector](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector'). Value must be positive. +The angle in degrees to rotate [vector](Velaptor.GameHelpers.md#vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector'). Value must be positive. `clockWise` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -Determines the direction the given [vector](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') should rotate around the [origin](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin'). +Determines the direction the given [vector](Velaptor.GameHelpers.md#vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') should rotate around the [origin](Velaptor.GameHelpers.md#origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin'). #### Returns [System.Numerics.Vector2](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector2 'System.Numerics.Vector2') -The [vector](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') rotated around the [origin](Velaptor.GameHelpers.md#Velaptor.GameHelpers.RotateAround(thisSystem.Numerics.Vector2,System.Numerics.Vector2,float,bool).origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin'). +The [vector](Velaptor.GameHelpers.md#vector 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).vector') rotated around the [origin](Velaptor.GameHelpers.md#origin 'Velaptor.GameHelpers.RotateAround(this System.Numerics.Vector2, System.Numerics.Vector2, float, bool).origin'). ### ToDegrees(this float) -Converts the given [radians](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ToDegrees(thisfloat).radians 'Velaptor.GameHelpers.ToDegrees(this float).radians') value into degrees. +Converts the given [radians](Velaptor.GameHelpers.md#radians 'Velaptor.GameHelpers.ToDegrees(this float).radians') value into degrees. ```csharp public static float ToDegrees(this float radians); @@ -759,7 +759,7 @@ The radians converted into degrees. ### ToRadians(this float) -Converts the given [degrees](Velaptor.GameHelpers.md#Velaptor.GameHelpers.ToRadians(thisfloat).degrees 'Velaptor.GameHelpers.ToRadians(this float).degrees') value into radians. +Converts the given [degrees](Velaptor.GameHelpers.md#degrees 'Velaptor.GameHelpers.ToRadians(this float).degrees') value into radians. ```csharp public static float ToRadians(this float degrees); @@ -800,4 +800,4 @@ A 4 component vector of color values. X = red. Y = green. Z = blue. -W = alpha. \ No newline at end of file +W = alpha. diff --git a/docs/api/Velaptor.Graphics.AtlasSubTextureData.md b/docs/api/Velaptor.Graphics.AtlasSubTextureData.md index 249887c5..100021da 100644 --- a/docs/api/Velaptor.Graphics.AtlasSubTextureData.md +++ b/docs/api/Velaptor.Graphics.AtlasSubTextureData.md @@ -55,4 +55,4 @@ public string Name { get; set; } ``` #### Property Value -[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') \ No newline at end of file +[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') diff --git a/docs/api/Velaptor.Graphics.CircleShape.md b/docs/api/Velaptor.Graphics.CircleShape.md index 32ce612b..9e15b065 100644 --- a/docs/api/Velaptor.Graphics.CircleShape.md +++ b/docs/api/Velaptor.Graphics.CircleShape.md @@ -43,9 +43,9 @@ public float BorderThickness { get; set; } #### Remarks -Only visible if the [IsSolid](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.IsSolid 'Velaptor.Graphics.CircleShape.IsSolid') property is set to `false`. +Only visible if the [IsSolid](Velaptor.Graphics.CircleShape.md#issolid 'Velaptor.Graphics.CircleShape.IsSolid') property is set to `false`.
-The border thickness is automatically restricted to a value no greater than the [Radius](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Radius 'Velaptor.Graphics.CircleShape.Radius'). +The border thickness is automatically restricted to a value no greater than the [Radius](Velaptor.Graphics.CircleShape.md#radius 'Velaptor.Graphics.CircleShape.Radius'). @@ -61,7 +61,7 @@ public float Bottom { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Position 'Velaptor.Graphics.CircleShape.Position') of the circle. +Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#position 'Velaptor.Graphics.CircleShape.Position') of the circle. @@ -77,7 +77,7 @@ public System.Drawing.Color Color { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -Ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientType 'Velaptor.Graphics.CircleShape.GradientType') is set to any value other than [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +Ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#gradienttype 'Velaptor.Graphics.CircleShape.GradientType') is set to any value other than [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -109,7 +109,7 @@ public System.Drawing.Color GradientStart { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -This property is ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientType 'Velaptor.Graphics.CircleShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +This property is ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#gradienttype 'Velaptor.Graphics.CircleShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -125,7 +125,7 @@ public System.Drawing.Color GradientStop { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -This property is ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientType 'Velaptor.Graphics.CircleShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +This property is ignored if the [GradientType](Velaptor.Graphics.CircleShape.md#gradienttype 'Velaptor.Graphics.CircleShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -142,18 +142,18 @@ public Velaptor.Graphics.ColorGradient GradientType { get; set; } #### Remarks -A value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None') will use the [Color](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Color 'Velaptor.Graphics.CircleShape.Color') +A value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None') will use the [Color](Velaptor.Graphics.CircleShape.md#color 'Velaptor.Graphics.CircleShape.Color') property and render the circle with a solid color. -A value of [Horizontal](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.Horizontal 'Velaptor.Graphics.ColorGradient.Horizontal') will ignore the [Color](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Color 'Velaptor.Graphics.CircleShape.Color') -property and use the [GradientStart](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStart 'Velaptor.Graphics.CircleShape.GradientStart')[GradientStop](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStop 'Velaptor.Graphics.CircleShape.GradientStop') properties. -This will render the circle with [GradientStart](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStart 'Velaptor.Graphics.CircleShape.GradientStart') color on the left side and gradually -render it to the right side as the [GradientStop](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStop 'Velaptor.Graphics.CircleShape.GradientStop') color. +A value of [Horizontal](Velaptor.Graphics.ColorGradient.md#horizontal 'Velaptor.Graphics.ColorGradient.Horizontal') will ignore the [Color](Velaptor.Graphics.CircleShape.md#color 'Velaptor.Graphics.CircleShape.Color') +property and use the [GradientStart](Velaptor.Graphics.CircleShape.md#gradientstart 'Velaptor.Graphics.CircleShape.GradientStart')[GradientStop](Velaptor.Graphics.CircleShape.md#gradientstop 'Velaptor.Graphics.CircleShape.GradientStop') properties. +This will render the circle with [GradientStart](Velaptor.Graphics.CircleShape.md#gradientstart 'Velaptor.Graphics.CircleShape.GradientStart') color on the left side and gradually +render it to the right side as the [GradientStop](Velaptor.Graphics.CircleShape.md#gradientstop 'Velaptor.Graphics.CircleShape.GradientStop') color. -A value of [Vertical](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.Vertical 'Velaptor.Graphics.ColorGradient.Vertical') will ignore the [Color](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Color 'Velaptor.Graphics.CircleShape.Color') -property and use the [GradientStart](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStart 'Velaptor.Graphics.CircleShape.GradientStart') and [GradientStop](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStop 'Velaptor.Graphics.CircleShape.GradientStop') properties. -This will render the circle with [GradientStart](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStart 'Velaptor.Graphics.CircleShape.GradientStart') color on the top and gradually -render it to the bottom as the [GradientStop](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.GradientStop 'Velaptor.Graphics.CircleShape.GradientStop') color. +A value of [Vertical](Velaptor.Graphics.ColorGradient.md#vertical 'Velaptor.Graphics.ColorGradient.Vertical') will ignore the [Color](Velaptor.Graphics.CircleShape.md#color 'Velaptor.Graphics.CircleShape.Color') +property and use the [GradientStart](Velaptor.Graphics.CircleShape.md#gradientstart 'Velaptor.Graphics.CircleShape.GradientStart') and [GradientStop](Velaptor.Graphics.CircleShape.md#gradientstop 'Velaptor.Graphics.CircleShape.GradientStop') properties. +This will render the circle with [GradientStart](Velaptor.Graphics.CircleShape.md#gradientstart 'Velaptor.Graphics.CircleShape.GradientStart') color on the top and gradually +render it to the bottom as the [GradientStop](Velaptor.Graphics.CircleShape.md#gradientstop 'Velaptor.Graphics.CircleShape.GradientStop') color. @@ -182,7 +182,7 @@ public float Left { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Position 'Velaptor.Graphics.CircleShape.Position') of the circle. +Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#position 'Velaptor.Graphics.CircleShape.Position') of the circle. @@ -214,9 +214,9 @@ public float Radius { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -This is half of the [Diameter](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Diameter 'Velaptor.Graphics.CircleShape.Diameter'). +This is half of the [Diameter](Velaptor.Graphics.CircleShape.md#diameter 'Velaptor.Graphics.CircleShape.Diameter').
-Changing the radius will automatically update the [Diameter](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Diameter 'Velaptor.Graphics.CircleShape.Diameter'). +Changing the radius will automatically update the [Diameter](Velaptor.Graphics.CircleShape.md#diameter 'Velaptor.Graphics.CircleShape.Diameter'). @@ -232,7 +232,7 @@ public float Right { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Position 'Velaptor.Graphics.CircleShape.Position') of the circle. +Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#position 'Velaptor.Graphics.CircleShape.Position') of the circle. @@ -248,7 +248,7 @@ public float Top { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#Velaptor.Graphics.CircleShape.Position 'Velaptor.Graphics.CircleShape.Position') of the circle. +Will automatically update the [Position](Velaptor.Graphics.CircleShape.md#position 'Velaptor.Graphics.CircleShape.Position') of the circle. ## Methods @@ -273,4 +273,4 @@ public bool IsEmpty(); #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -True if empty. \ No newline at end of file +True if empty. diff --git a/docs/api/Velaptor.Graphics.ColorGradient.md b/docs/api/Velaptor.Graphics.ColorGradient.md index 2f82b321..eb135a75 100644 --- a/docs/api/Velaptor.Graphics.ColorGradient.md +++ b/docs/api/Velaptor.Graphics.ColorGradient.md @@ -30,4 +30,4 @@ No gradient is applied. `Vertical` 2 -A vertical gradient is applied. \ No newline at end of file +A vertical gradient is applied. diff --git a/docs/api/Velaptor.Graphics.CornerRadius.md b/docs/api/Velaptor.Graphics.CornerRadius.md index 88a9e738..eeeb2352 100644 --- a/docs/api/Velaptor.Graphics.CornerRadius.md +++ b/docs/api/Velaptor.Graphics.CornerRadius.md @@ -155,7 +155,7 @@ True if empty. ### SetBottomLeft(CornerRadius, float) -Sets the bottom left corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius,float).cornerRadius 'Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius,float).value 'Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius, float).value'). +Sets the bottom left corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#cornerradius 'Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#value 'Velaptor.Graphics.CornerRadius.SetBottomLeft(Velaptor.Graphics.CornerRadius, float).value'). ```csharp public static Velaptor.Graphics.CornerRadius SetBottomLeft(Velaptor.Graphics.CornerRadius cornerRadius, float value); @@ -182,7 +182,7 @@ The corner radius with the updated value. ### SetBottomRight(CornerRadius, float) -Sets the bottom right corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius,float).cornerRadius 'Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius,float).value 'Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius, float).value'). +Sets the bottom right corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#cornerradius 'Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#value 'Velaptor.Graphics.CornerRadius.SetBottomRight(Velaptor.Graphics.CornerRadius, float).value'). ```csharp public static Velaptor.Graphics.CornerRadius SetBottomRight(Velaptor.Graphics.CornerRadius cornerRadius, float value); @@ -209,7 +209,7 @@ The corner radius with the updated value. ### SetTopLeft(CornerRadius, float) -Sets the top left corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius,float).cornerRadius 'Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius,float).value 'Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius, float).value'). +Sets the top left corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#cornerradius 'Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#value 'Velaptor.Graphics.CornerRadius.SetTopLeft(Velaptor.Graphics.CornerRadius, float).value'). ```csharp public static Velaptor.Graphics.CornerRadius SetTopLeft(Velaptor.Graphics.CornerRadius cornerRadius, float value); @@ -236,7 +236,7 @@ The corner radius with the updated value. ### SetTopRight(CornerRadius, float) -Sets the top right corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius,float).cornerRadius 'Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius,float).value 'Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius, float).value'). +Sets the top right corner value of the given [cornerRadius](Velaptor.Graphics.CornerRadius.md#cornerradius 'Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius, float).cornerRadius') to the given [value](Velaptor.Graphics.CornerRadius.md#value 'Velaptor.Graphics.CornerRadius.SetTopRight(Velaptor.Graphics.CornerRadius, float).value'). ```csharp public static Velaptor.Graphics.CornerRadius SetTopRight(Velaptor.Graphics.CornerRadius cornerRadius, float value); @@ -257,4 +257,4 @@ The value to set. #### Returns [CornerRadius](Velaptor.Graphics.CornerRadius.md 'Velaptor.Graphics.CornerRadius') -The corner radius with the updated value. \ No newline at end of file +The corner radius with the updated value. diff --git a/docs/api/Velaptor.Graphics.GlyphMetrics.md b/docs/api/Velaptor.Graphics.GlyphMetrics.md index 2458fed1..410233f8 100644 --- a/docs/api/Velaptor.Graphics.GlyphMetrics.md +++ b/docs/api/Velaptor.Graphics.GlyphMetrics.md @@ -90,7 +90,7 @@ public char Glyph { get; set; } ### GlyphBounds Gets the rectangular bounds of where in a font texture -atlas the given [Glyph](Velaptor.Graphics.GlyphMetrics.md#Velaptor.Graphics.GlyphMetrics.Glyph 'Velaptor.Graphics.GlyphMetrics.Glyph') resides. +atlas the given [Glyph](Velaptor.Graphics.GlyphMetrics.md#glyph 'Velaptor.Graphics.GlyphMetrics.Glyph') resides. ```csharp public System.Drawing.RectangleF GlyphBounds { get; set; } @@ -217,4 +217,4 @@ public float YMin { get; set; } ``` #### Property Value -[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') \ No newline at end of file +[System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') diff --git a/docs/api/Velaptor.Graphics.IImageLoader.md b/docs/api/Velaptor.Graphics.IImageLoader.md index d5d5e6d5..84aa9f7f 100644 --- a/docs/api/Velaptor.Graphics.IImageLoader.md +++ b/docs/api/Velaptor.Graphics.IImageLoader.md @@ -36,4 +36,4 @@ The path to the image file. #### Returns [ImageData](Velaptor.Graphics.ImageData.md 'Velaptor.Graphics.ImageData') -The image data. \ No newline at end of file +The image data. diff --git a/docs/api/Velaptor.Graphics.IRenderContext.md b/docs/api/Velaptor.Graphics.IRenderContext.md index ba6d52f3..30af1cc8 100644 --- a/docs/api/Velaptor.Graphics.IRenderContext.md +++ b/docs/api/Velaptor.Graphics.IRenderContext.md @@ -55,4 +55,4 @@ The width in pixels of the area. The height in pixels of the area. #### Remarks -This is synonymous with the OpenGL viewport. \ No newline at end of file +This is synonymous with the OpenGL viewport. diff --git a/docs/api/Velaptor.Graphics.IRenderMediator.md b/docs/api/Velaptor.Graphics.IRenderMediator.md index ab348de4..1b33f041 100644 --- a/docs/api/Velaptor.Graphics.IRenderMediator.md +++ b/docs/api/Velaptor.Graphics.IRenderMediator.md @@ -11,4 +11,4 @@ Manages rendering between the different renderers. ```csharp public interface IRenderMediator -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Graphics.ImageData.md b/docs/api/Velaptor.Graphics.ImageData.md index e747721a..75af813d 100644 --- a/docs/api/Velaptor.Graphics.ImageData.md +++ b/docs/api/Velaptor.Graphics.ImageData.md @@ -41,7 +41,7 @@ The pixel data of the image. The file path of where the image exists. #### Remarks -The [filePath](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.ImageData(System.Drawing.Color[,],string).filePath 'Velaptor.Graphics.ImageData.ImageData(System.Drawing.Color[,], string).filePath') is used for reference only. +The [filePath](Velaptor.Graphics.ImageData.md#filepath 'Velaptor.Graphics.ImageData.ImageData(System.Drawing.Color[,], string).filePath') is used for reference only. ## Properties @@ -136,8 +136,8 @@ public uint Width { get; } ### DrawImage(ImageData, Point) -Draws the given [image](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData,System.Drawing.Point).image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') onto this image, -starting at the given [location](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData,System.Drawing.Point).location 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).location'). +Draws the given [image](Velaptor.Graphics.ImageData.md#image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') onto this image, +starting at the given [location](Velaptor.Graphics.ImageData.md#location 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).location'). ```csharp public Velaptor.Graphics.ImageData DrawImage(Velaptor.Graphics.ImageData image, System.Drawing.Point location); @@ -155,14 +155,14 @@ The image to draw onto this one. `location` [System.Drawing.Point](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Point 'System.Drawing.Point') The location of where to draw the image. -References the top left corner of the given [image](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData,System.Drawing.Point).image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image'). +References the top left corner of the given [image](Velaptor.Graphics.ImageData.md#image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image'). #### Returns [ImageData](Velaptor.Graphics.ImageData.md 'Velaptor.Graphics.ImageData') -This current image with the given [image](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData,System.Drawing.Point).image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') painted onto it. +This current image with the given [image](Velaptor.Graphics.ImageData.md#image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') painted onto it. #### Remarks -If a pixel of the given [image](Velaptor.Graphics.ImageData.md#Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData,System.Drawing.Point).image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') is outside of the bounds of this +If a pixel of the given [image](Velaptor.Graphics.ImageData.md#image 'Velaptor.Graphics.ImageData.DrawImage(Velaptor.Graphics.ImageData, System.Drawing.Point).image') is outside of the bounds of this image, it will be skipped. @@ -246,4 +246,4 @@ public override string ToString(); #### Returns [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The fully qualified type name. \ No newline at end of file +The fully qualified type name. diff --git a/docs/api/Velaptor.Graphics.ImageLoader.md b/docs/api/Velaptor.Graphics.ImageLoader.md index 8e7224d5..7fd3e840 100644 --- a/docs/api/Velaptor.Graphics.ImageLoader.md +++ b/docs/api/Velaptor.Graphics.ImageLoader.md @@ -54,7 +54,7 @@ Implements [LoadImage(string)](Velaptor.Graphics.IImageLoader.md#Velaptor.Graphi The image data. #### Remarks -If the [filePath](Velaptor.Graphics.ImageLoader.md#Velaptor.Graphics.ImageLoader.LoadImage(string).filePath 'Velaptor.Graphics.ImageLoader.LoadImage(string).filePath') is a relative path, it will be resolved +If the [filePath](Velaptor.Graphics.ImageLoader.md#filepath 'Velaptor.Graphics.ImageLoader.LoadImage(string).filePath') is a relative path, it will be resolved to the content directory of the application.
-The default content directory is Content/Graphics/. \ No newline at end of file +The default content directory is Content/Graphics/. diff --git a/docs/api/Velaptor.Graphics.Line.md b/docs/api/Velaptor.Graphics.Line.md index 6d9e7480..2810a6c7 100644 --- a/docs/api/Velaptor.Graphics.Line.md +++ b/docs/api/Velaptor.Graphics.Line.md @@ -184,4 +184,4 @@ public float Thickness { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Restricts the thickness to a minimum value of 1. \ No newline at end of file +Restricts the thickness to a minimum value of 1. diff --git a/docs/api/Velaptor.Graphics.RectShape.md b/docs/api/Velaptor.Graphics.RectShape.md index 0cfbf1f1..75192f50 100644 --- a/docs/api/Velaptor.Graphics.RectShape.md +++ b/docs/api/Velaptor.Graphics.RectShape.md @@ -43,9 +43,9 @@ public float BorderThickness { get; set; } #### Remarks -Ignored if the [IsSolid](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.IsSolid 'Velaptor.Graphics.RectShape.IsSolid') property is set to `true`. +Ignored if the [IsSolid](Velaptor.Graphics.RectShape.md#issolid 'Velaptor.Graphics.RectShape.IsSolid') property is set to `true`. -The value of a corner will never be larger than the smallest half [Width](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Width 'Velaptor.Graphics.RectShape.Width') or half [Height](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Height 'Velaptor.Graphics.RectShape.Height'). +The value of a corner will never be larger than the smallest half [Width](Velaptor.Graphics.RectShape.md#width 'Velaptor.Graphics.RectShape.Width') or half [Height](Velaptor.Graphics.RectShape.md#height 'Velaptor.Graphics.RectShape.Height'). @@ -61,7 +61,7 @@ public float Bottom { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Position 'Velaptor.Graphics.RectShape.Position') of the rectangle. +Will automatically update the [Position](Velaptor.Graphics.RectShape.md#position 'Velaptor.Graphics.RectShape.Position') of the rectangle. @@ -77,7 +77,7 @@ public System.Drawing.Color Color { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -Ignored if the [GradientType](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientType 'Velaptor.Graphics.RectShape.GradientType') is set to any value other than [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +Ignored if the [GradientType](Velaptor.Graphics.RectShape.md#gradienttype 'Velaptor.Graphics.RectShape.GradientType') is set to any value other than [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -93,7 +93,7 @@ public Velaptor.Graphics.CornerRadius CornerRadius { get; set; } [CornerRadius](Velaptor.Graphics.CornerRadius.md 'Velaptor.Graphics.CornerRadius') #### Remarks -The value of a corner will never be larger than the smallest half [Width](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Width 'Velaptor.Graphics.RectShape.Width') or half [Height](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Height 'Velaptor.Graphics.RectShape.Height'). +The value of a corner will never be larger than the smallest half [Width](Velaptor.Graphics.RectShape.md#width 'Velaptor.Graphics.RectShape.Width') or half [Height](Velaptor.Graphics.RectShape.md#height 'Velaptor.Graphics.RectShape.Height'). @@ -109,7 +109,7 @@ public System.Drawing.Color GradientStart { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -This property is ignored if the [GradientType](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientType 'Velaptor.Graphics.RectShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +This property is ignored if the [GradientType](Velaptor.Graphics.RectShape.md#gradienttype 'Velaptor.Graphics.RectShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -125,7 +125,7 @@ public System.Drawing.Color GradientStop { get; set; } [System.Drawing.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Color 'System.Drawing.Color') #### Remarks -This property is ignored if the [GradientType](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientType 'Velaptor.Graphics.RectShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None'). +This property is ignored if the [GradientType](Velaptor.Graphics.RectShape.md#gradienttype 'Velaptor.Graphics.RectShape.GradientType') is set to a value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None'). @@ -142,18 +142,18 @@ public Velaptor.Graphics.ColorGradient GradientType { get; set; } #### Remarks -A value of [None](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.None 'Velaptor.Graphics.ColorGradient.None') will use the [Color](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Color 'Velaptor.Graphics.RectShape.Color') +A value of [None](Velaptor.Graphics.ColorGradient.md#none 'Velaptor.Graphics.ColorGradient.None') will use the [Color](Velaptor.Graphics.RectShape.md#color 'Velaptor.Graphics.RectShape.Color') property and render the rectangle with a solid color. -A value of [Horizontal](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.Horizontal 'Velaptor.Graphics.ColorGradient.Horizontal') will ignore the [Color](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Color 'Velaptor.Graphics.RectShape.Color') -property and use the [GradientStart](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStart 'Velaptor.Graphics.RectShape.GradientStart')[GradientStop](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStop 'Velaptor.Graphics.RectShape.GradientStop') properties. -This will render the rectangle with [GradientStart](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStart 'Velaptor.Graphics.RectShape.GradientStart') color on the left side and gradually -render it to the right side as the [GradientStop](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStop 'Velaptor.Graphics.RectShape.GradientStop') color. +A value of [Horizontal](Velaptor.Graphics.ColorGradient.md#horizontal 'Velaptor.Graphics.ColorGradient.Horizontal') will ignore the [Color](Velaptor.Graphics.RectShape.md#color 'Velaptor.Graphics.RectShape.Color') +property and use the [GradientStart](Velaptor.Graphics.RectShape.md#gradientstart 'Velaptor.Graphics.RectShape.GradientStart')[GradientStop](Velaptor.Graphics.RectShape.md#gradientstop 'Velaptor.Graphics.RectShape.GradientStop') properties. +This will render the rectangle with [GradientStart](Velaptor.Graphics.RectShape.md#gradientstart 'Velaptor.Graphics.RectShape.GradientStart') color on the left side and gradually +render it to the right side as the [GradientStop](Velaptor.Graphics.RectShape.md#gradientstop 'Velaptor.Graphics.RectShape.GradientStop') color. -A value of [Vertical](Velaptor.Graphics.ColorGradient.md#Velaptor.Graphics.ColorGradient.Vertical 'Velaptor.Graphics.ColorGradient.Vertical') will ignore the [Color](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Color 'Velaptor.Graphics.RectShape.Color') -property and use the [GradientStart](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStart 'Velaptor.Graphics.RectShape.GradientStart') and [GradientStop](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStop 'Velaptor.Graphics.RectShape.GradientStop') properties. -This will render the rectangle with [GradientStart](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStart 'Velaptor.Graphics.RectShape.GradientStart') color on the top and gradually -render it to the bottom as the [GradientStop](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.GradientStop 'Velaptor.Graphics.RectShape.GradientStop') color. +A value of [Vertical](Velaptor.Graphics.ColorGradient.md#vertical 'Velaptor.Graphics.ColorGradient.Vertical') will ignore the [Color](Velaptor.Graphics.RectShape.md#color 'Velaptor.Graphics.RectShape.Color') +property and use the [GradientStart](Velaptor.Graphics.RectShape.md#gradientstart 'Velaptor.Graphics.RectShape.GradientStart') and [GradientStop](Velaptor.Graphics.RectShape.md#gradientstop 'Velaptor.Graphics.RectShape.GradientStop') properties. +This will render the rectangle with [GradientStart](Velaptor.Graphics.RectShape.md#gradientstart 'Velaptor.Graphics.RectShape.GradientStart') color on the top and gradually +render it to the bottom as the [GradientStop](Velaptor.Graphics.RectShape.md#gradientstop 'Velaptor.Graphics.RectShape.GradientStop') color. @@ -224,7 +224,7 @@ public float Left { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Position 'Velaptor.Graphics.RectShape.Position') of the rectangle. +Will automatically update the [Position](Velaptor.Graphics.RectShape.md#position 'Velaptor.Graphics.RectShape.Position') of the rectangle. @@ -256,7 +256,7 @@ public float Right { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Position 'Velaptor.Graphics.RectShape.Position') of the rectangle. +Will automatically update the [Position](Velaptor.Graphics.RectShape.md#position 'Velaptor.Graphics.RectShape.Position') of the rectangle. @@ -272,7 +272,7 @@ public float Top { get; set; } [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') #### Remarks -Will automatically update the [Position](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Position 'Velaptor.Graphics.RectShape.Position') of the rectangle. +Will automatically update the [Position](Velaptor.Graphics.RectShape.md#position 'Velaptor.Graphics.RectShape.Position') of the rectangle. @@ -310,10 +310,10 @@ The possibly contained [System.Numerics.Vector2](https://docs.microsoft.com/en-u #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -`true` if the [vector](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Contains(System.Numerics.Vector2).vector 'Velaptor.Graphics.RectShape.Contains(System.Numerics.Vector2).vector') is contained. +`true` if the [vector](Velaptor.Graphics.RectShape.md#vector 'Velaptor.Graphics.RectShape.Contains(System.Numerics.Vector2).vector') is contained. #### Remarks -The [Left](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Left 'Velaptor.Graphics.RectShape.Left') or [Right](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Right 'Velaptor.Graphics.RectShape.Right') or [Top](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Top 'Velaptor.Graphics.RectShape.Top') or [Bottom](Velaptor.Graphics.RectShape.md#Velaptor.Graphics.RectShape.Bottom 'Velaptor.Graphics.RectShape.Bottom') are inclusive. +The [Left](Velaptor.Graphics.RectShape.md#left 'Velaptor.Graphics.RectShape.Left') or [Right](Velaptor.Graphics.RectShape.md#right 'Velaptor.Graphics.RectShape.Right') or [Top](Velaptor.Graphics.RectShape.md#top 'Velaptor.Graphics.RectShape.Top') or [Bottom](Velaptor.Graphics.RectShape.md#bottom 'Velaptor.Graphics.RectShape.Bottom') are inclusive. @@ -337,4 +337,4 @@ public bool IsEmpty(); #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -True if empty. \ No newline at end of file +True if empty. diff --git a/docs/api/Velaptor.Graphics.RenderEffects.md b/docs/api/Velaptor.Graphics.RenderEffects.md index 2c7709ad..64e0d491 100644 --- a/docs/api/Velaptor.Graphics.RenderEffects.md +++ b/docs/api/Velaptor.Graphics.RenderEffects.md @@ -36,4 +36,4 @@ The texture is flipped vertically. `None` 0 -No effects are applied. \ No newline at end of file +No effects are applied. diff --git a/docs/api/Velaptor.Graphics.Renderers.Exceptions.RendererException.md b/docs/api/Velaptor.Graphics.Renderers.Exceptions.RendererException.md index b69974b4..7cb8deec 100644 --- a/docs/api/Velaptor.Graphics.Renderers.Exceptions.RendererException.md +++ b/docs/api/Velaptor.Graphics.Renderers.Exceptions.RendererException.md @@ -64,4 +64,4 @@ public RendererException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Graphics.Renderers.Exceptions.md b/docs/api/Velaptor.Graphics.Renderers.Exceptions.md index 7a79c5e1..7c93e16b 100644 --- a/docs/api/Velaptor.Graphics.Renderers.Exceptions.md +++ b/docs/api/Velaptor.Graphics.Renderers.Exceptions.md @@ -9,3 +9,4 @@ title: Velaptor.Graphics.Renderers.Exceptions | Classes | | | :--- | :--- | | [RendererException](Velaptor.Graphics.Renderers.Exceptions.RendererException.md 'Velaptor.Graphics.Renderers.Exceptions.RendererException') | Thrown when there is a renderer type of issue. | + diff --git a/docs/api/Velaptor.Graphics.Renderers.IFontRenderer.md b/docs/api/Velaptor.Graphics.Renderers.IFontRenderer.md index 30d51a59..a5b4db56 100644 --- a/docs/api/Velaptor.Graphics.Renderers.IFontRenderer.md +++ b/docs/api/Velaptor.Graphics.Renderers.IFontRenderer.md @@ -18,8 +18,8 @@ public interface IFontRenderer ### Render(IFont, string, int, int, float, float, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).font') -at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).y') coordinates. +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).font') +at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).y') coordinates. ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float renderSize, float angle, int layer=0); @@ -30,7 +30,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).text'). @@ -75,14 +75,14 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).y') position is based in the center of the text. +The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).y') position is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).renderSize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered +The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#rendersize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered at the standard size of 100%. Example: Using 1.5 would represent 150% or 50% larger than the normal size. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -103,9 +103,9 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, int, int, float, float, Color, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).font') -at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).y') coordinates, -with the given [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).angle'), [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).renderSize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).renderSize'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).color'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).font') +at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).y') coordinates, +with the given [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).angle'), [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#rendersize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).renderSize'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).color'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float renderSize, float angle, System.Drawing.Color color, int layer=0); @@ -116,7 +116,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).text'). @@ -167,14 +167,14 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).y') position is based in the center of the text. +The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).y') position is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).renderSize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered +The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#rendersize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered at the standard size of 100%. Example: Using 1.5 would represent 150% or 50% larger than the normal size. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, float, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -195,9 +195,9 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, int, int, float, Color, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).font') -at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).y') coordinates, -with the given [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).angle'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).color'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).font') +at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).y') coordinates, +with the given [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).angle'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).color'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float angle, System.Drawing.Color color, int layer=0); @@ -208,7 +208,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, float `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).text'). @@ -248,11 +248,11 @@ The layer to render the text. #### Remarks -The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).y') position is based in the center of the text. +The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).y') position is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, float, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -273,8 +273,8 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, int, int, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).font') -at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).y') coordinates. +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).font') +at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).y') coordinates. ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, int layer=0); @@ -285,7 +285,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, int la `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).text'). @@ -318,11 +318,11 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).y') position is based in the center of the text. +The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).y') position is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -343,9 +343,9 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, int, int, Color, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).font') -at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).y') coordinates -and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).color'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).font') +at the position determined by the given [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).y') coordinates +and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).color'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, System.Drawing.Color color, int layer=0); @@ -356,7 +356,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, int x, int y, System `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).text'). @@ -395,14 +395,14 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).y') position is based in the center of the text. +The [x](Velaptor.Graphics.Renderers.IFontRenderer.md#x 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.IFontRenderer.md#y 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).y') position is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. The size is a value between 0 and 1. Using the value 1 represents the text being rendered at the standard size of 100%. Example: Using 1.5 would represent 150% or 50% larger than the normal size. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, int, int, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -423,8 +423,8 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, Vector2, float, float, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).font') -at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).position'), with the given [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).renderSize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).renderSize'), and [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).angle'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).font') +at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).position'), with the given [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#rendersize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).renderSize'), and [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).angle'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vector2 position, float renderSize, float angle, int layer=0); @@ -435,7 +435,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vect `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).text'). @@ -474,14 +474,14 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).position') is based in the center of the text. +The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).position') is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).renderSize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered +The [renderSize](Velaptor.Graphics.Renderers.IFontRenderer.md#rendersize 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).renderSize') is a value between 0 and 1. Using the value 1 represents the text being rendered at the standard size of 100%. Example: Using 1.5 would represent 150% or 50% larger than the normal size. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,float,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, float, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -502,8 +502,8 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, Vector2, float, Color, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).font') -at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).position'), [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).angle'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).color'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).font') +at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).position'), [angle](Velaptor.Graphics.Renderers.IFontRenderer.md#angle 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).angle'), and [color](Velaptor.Graphics.Renderers.IFontRenderer.md#color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).color'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vector2 position, float angle, System.Drawing.Color color, int layer=0); @@ -514,7 +514,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vect `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).text'). @@ -553,11 +553,11 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).position') is based in the center of the text. +The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).position') is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,float,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, float, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -578,8 +578,8 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, Vector2, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).font') -and [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).position'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).font') +and [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).position'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vector2 position, int layer=0); @@ -590,7 +590,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vect `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).text'). @@ -617,11 +617,11 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).position') is based in the center of the text. +The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).position') is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -642,8 +642,8 @@ Example below:Render Method Invoked Order: ### Render(IFont, string, Vector2, Color, int) -Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).font') -at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).position') with the given [color](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).color'). +Renders the given [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).text') using the given [font](Velaptor.Graphics.Renderers.IFontRenderer.md#font 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).font') +at the given [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).position') with the given [color](Velaptor.Graphics.Renderers.IFontRenderer.md#color 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).color'). ```csharp void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vector2 position, System.Drawing.Color color, int layer=0); @@ -654,7 +654,7 @@ void Render(Velaptor.Content.Fonts.IFont font, string text, System.Numerics.Vect `font` [IFont](Velaptor.Content.Fonts.IFont.md 'Velaptor.Content.Fonts.IFont') -The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).text'). +The font to use for rendering the [text](Velaptor.Graphics.Renderers.IFontRenderer.md#text 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).text'). @@ -687,11 +687,11 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).position') is based in the center of the text. +The [position](Velaptor.Graphics.Renderers.IFontRenderer.md#position 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).position') is based in the center of the text. The center of the text is based on the furthest most left, right, top, and bottom edges of the text. -Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont,string,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IFontRenderer.md#layer 'Velaptor.Graphics.Renderers.IFontRenderer.Render(Velaptor.Content.Fonts.IFont, string, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -743,4 +743,4 @@ void Render(Velaptor.Content.Fonts.IFont font, System.Span<(Velaptor.Graphics.Gl -`layer` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file +`layer` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') diff --git a/docs/api/Velaptor.Graphics.Renderers.ILineRenderer.md b/docs/api/Velaptor.Graphics.Renderers.ILineRenderer.md index 83145c38..6e3e4219 100644 --- a/docs/api/Velaptor.Graphics.Renderers.ILineRenderer.md +++ b/docs/api/Velaptor.Graphics.Renderers.ILineRenderer.md @@ -18,7 +18,7 @@ public interface ILineRenderer ### Render(Line, int) -Renders the given [line](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line,int).line 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).line'). +Renders the given [line](Velaptor.Graphics.Renderers.ILineRenderer.md#line 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).line'). ```csharp void Render(Velaptor.Graphics.Line line, int layer=0); @@ -44,8 +44,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.Render(Velaptor.Graphics.Line, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -66,7 +66,7 @@ Example below:Render Method Invoked Order: ### RenderLine(Vector2, Vector2, int) -Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer'). +Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer'). ```csharp void RenderLine(System.Numerics.Vector2 start, System.Numerics.Vector2 end, int layer=0); @@ -98,8 +98,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -120,8 +120,8 @@ Example below:Render Method Invoked Order: ### RenderLine(Vector2, Vector2, Color, int) -Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') -using the given [color](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).color 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).color'). +Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') +using the given [color](Velaptor.Graphics.Renderers.ILineRenderer.md#color 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).color'). ```csharp void RenderLine(System.Numerics.Vector2 start, System.Numerics.Vector2 end, System.Drawing.Color color, int layer=0); @@ -159,8 +159,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -181,8 +181,8 @@ Example below:Render Method Invoked Order: ### RenderLine(Vector2, Vector2, Color, uint, int) -Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') -using the given [color](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).color 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).color') and line [thickness](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).thickness 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).thickness'). +Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') +using the given [color](Velaptor.Graphics.Renderers.ILineRenderer.md#color 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).color') and line [thickness](Velaptor.Graphics.Renderers.ILineRenderer.md#thickness 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).thickness'). ```csharp void RenderLine(System.Numerics.Vector2 start, System.Numerics.Vector2 end, System.Drawing.Color color, uint thickness, int layer=0); @@ -226,8 +226,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,System.Drawing.Color,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, System.Drawing.Color, uint, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -248,8 +248,8 @@ Example below:Render Method Invoked Order: ### RenderLine(Vector2, Vector2, uint, int) -Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') -using the given line [thickness](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).thickness 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).thickness'). +Renders a line using the given [start](Velaptor.Graphics.Renderers.ILineRenderer.md#start 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).start') and [end](Velaptor.Graphics.Renderers.ILineRenderer.md#end 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).end') vectors on the given [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') +using the given line [thickness](Velaptor.Graphics.Renderers.ILineRenderer.md#thickness 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).thickness'). ```csharp void RenderLine(System.Numerics.Vector2 start, System.Numerics.Vector2 end, uint thickness, int layer=0); @@ -287,8 +287,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2,System.Numerics.Vector2,uint,int).layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ILineRenderer.md#layer 'Velaptor.Graphics.Renderers.ILineRenderer.RenderLine(System.Numerics.Vector2, System.Numerics.Vector2, uint, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -303,4 +303,4 @@ Example below:Render Method Invoked Order: - Texture 3 - Texture 4 - Texture 6 -- Texture 5 \ No newline at end of file +- Texture 5 diff --git a/docs/api/Velaptor.Graphics.Renderers.IShapeRenderer.md b/docs/api/Velaptor.Graphics.Renderers.IShapeRenderer.md index 8cd0dfd0..efe34866 100644 --- a/docs/api/Velaptor.Graphics.Renderers.IShapeRenderer.md +++ b/docs/api/Velaptor.Graphics.Renderers.IShapeRenderer.md @@ -18,7 +18,7 @@ public interface IShapeRenderer ### Render(CircleShape, int) -Renders the given [circle](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape,int).circle 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).circle'). +Renders the given [circle](Velaptor.Graphics.Renderers.IShapeRenderer.md#circle 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).circle'). ```csharp void Render(Velaptor.Graphics.CircleShape circle, int layer=0); @@ -44,8 +44,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.CircleShape, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -66,7 +66,7 @@ Example below:Render Method Invoked Order: ### Render(RectShape, int) -Renders the given [rect](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape,int).rect 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).rect'). +Renders the given [rect](Velaptor.Graphics.Renderers.IShapeRenderer.md#rect 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).rect'). ```csharp void Render(Velaptor.Graphics.RectShape rect, int layer=0); @@ -92,8 +92,8 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -Lower [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape,int).layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.IShapeRenderer.md#layer 'Velaptor.Graphics.Renderers.IShapeRenderer.Render(Velaptor.Graphics.RectShape, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -108,4 +108,4 @@ Example below:Render Method Invoked Order: - Texture 3 - Texture 4 - Texture 6 -- Texture 5 \ No newline at end of file +- Texture 5 diff --git a/docs/api/Velaptor.Graphics.Renderers.ITextureRenderer.md b/docs/api/Velaptor.Graphics.Renderers.ITextureRenderer.md index dc4b4a55..467773af 100644 --- a/docs/api/Velaptor.Graphics.Renderers.ITextureRenderer.md +++ b/docs/api/Velaptor.Graphics.Renderers.ITextureRenderer.md @@ -18,7 +18,7 @@ public interface ITextureRenderer ### Render(ITexture, int, int, float, int) -Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).y') coordinates and the given [angle](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).angle 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).angle'). +Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).y') coordinates and the given [angle](Velaptor.Graphics.Renderers.ITextureRenderer.md#angle 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).angle'). ```csharp void Render(Velaptor.Content.ITexture texture, int x, int y, float angle, int layer=0); @@ -62,10 +62,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).y') position are based in the center of the texture. +The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).y') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, float, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -86,7 +86,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, int, int, int) -Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).y') coordinates. +Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).y') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, int x, int y, int layer=0); @@ -124,10 +124,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).y') position are based in the center of the texture. +The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).y') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -148,7 +148,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, int, int, Color, int) -Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).y') coordinates. +Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).y') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, int x, int y, System.Drawing.Color color, int layer=0); @@ -192,10 +192,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).y') position is based in the center of the texture. +The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).y') position is based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -216,7 +216,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, int, int, Color, RenderEffects, int) -Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).y') coordinates. +Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).y') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, int x, int y, System.Drawing.Color color, Velaptor.Graphics.RenderEffects effects, int layer=0); @@ -266,10 +266,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).y') position is based in the center of the texture. +The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).y') position is based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -290,7 +290,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, int, int, RenderEffects, int) -Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).y') coordinates. +Renders the given texture at the given [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).y') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, int x, int y, Velaptor.Graphics.RenderEffects effects, int layer=0); @@ -334,10 +334,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).y') position is based in the center of the texture. +The [x](Velaptor.Graphics.Renderers.ITextureRenderer.md#x 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).x') and [y](Velaptor.Graphics.Renderers.ITextureRenderer.md#y 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).y') position is based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,int,int,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, int, int, Velaptor.Graphics.RenderEffects, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -420,10 +420,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The position in the [destRect](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Drawing.Rectangle,System.Drawing.Rectangle,float,float,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).destRect 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).destRect') is based in the center of the texture. +The position in the [destRect](Velaptor.Graphics.Renderers.ITextureRenderer.md#destrect 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).destRect') is based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Drawing.Rectangle,System.Drawing.Rectangle,float,float,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Drawing.Rectangle,System.Drawing.Rectangle,float,float,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Drawing.Rectangle,System.Drawing.Rectangle,float,float,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Drawing.Rectangle, System.Drawing.Rectangle, float, float, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -444,7 +444,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, Vector2, float, int) -Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).pos') coordinates and the given [angle](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).angle 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).angle'). +Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).pos') coordinates and the given [angle](Velaptor.Graphics.Renderers.ITextureRenderer.md#angle 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).angle'). ```csharp void Render(Velaptor.Content.ITexture texture, System.Numerics.Vector2 pos, float angle, int layer=0); @@ -482,10 +482,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).pos') position are based in the center of the texture. +The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).pos') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,float,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, float, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -506,7 +506,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, Vector2, int) -Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).pos') coordinates. +Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).pos') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, System.Numerics.Vector2 pos, int layer=0); @@ -538,10 +538,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).pos') position are based in the center of the texture. +The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).pos') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -562,7 +562,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, Vector2, Color, int) -Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).pos') coordinates. +Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).pos') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, System.Numerics.Vector2 pos, System.Drawing.Color color, int layer=0); @@ -600,10 +600,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).pos') position are based in the center of the texture. +The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).pos') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -624,7 +624,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, Vector2, Color, RenderEffects, int) -Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).pos') coordinates. +Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).pos') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, System.Numerics.Vector2 pos, System.Drawing.Color color, Velaptor.Graphics.RenderEffects effects, int layer=0); @@ -668,10 +668,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).pos') position are based in the center of the texture. +The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).pos') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,System.Drawing.Color,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, System.Drawing.Color, Velaptor.Graphics.RenderEffects, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -692,7 +692,7 @@ Example below:Render Method Invoked Order: ### Render(ITexture, Vector2, RenderEffects, int) -Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,Velaptor.Graphics.RenderEffects,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).pos') coordinates. +Renders the given texture at the given [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).pos') coordinates. ```csharp void Render(Velaptor.Content.ITexture texture, System.Numerics.Vector2 pos, Velaptor.Graphics.RenderEffects effects, int layer=0); @@ -730,10 +730,10 @@ Thrown if the [Begin()](Velaptor.Batching.IBatcher.md#Velaptor.Batching.IBatcher #### Remarks -The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,Velaptor.Graphics.RenderEffects,int).pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).pos') position are based in the center of the texture. +The [pos](Velaptor.Graphics.Renderers.ITextureRenderer.md#pos 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).pos') position are based in the center of the texture. -Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') values. -If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture,System.Numerics.Vector2,Velaptor.Graphics.RenderEffects,int).layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') value, they will +Lower [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') values will render before higher [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') values. +If two separate textures have the same [layer](Velaptor.Graphics.Renderers.ITextureRenderer.md#layer 'Velaptor.Graphics.Renderers.ITextureRenderer.Render(Velaptor.Content.ITexture, System.Numerics.Vector2, Velaptor.Graphics.RenderEffects, int).layer') value, they will render in the order that the method was invoked. Example below:Render Method Invoked Order: @@ -748,4 +748,4 @@ Example below:Render Method Invoked Order: - Texture 3 - Texture 4 - Texture 6 -- Texture 5 \ No newline at end of file +- Texture 5 diff --git a/docs/api/Velaptor.Graphics.Renderers.md b/docs/api/Velaptor.Graphics.Renderers.md index 091c5240..4bdac6f9 100644 --- a/docs/api/Velaptor.Graphics.Renderers.md +++ b/docs/api/Velaptor.Graphics.Renderers.md @@ -12,3 +12,4 @@ title: Velaptor.Graphics.Renderers | [ILineRenderer](Velaptor.Graphics.Renderers.ILineRenderer.md 'Velaptor.Graphics.Renderers.ILineRenderer') | Renders lines to the screen. | | [IShapeRenderer](Velaptor.Graphics.Renderers.IShapeRenderer.md 'Velaptor.Graphics.Renderers.IShapeRenderer') | Renders rectangles to the screen. | | [ITextureRenderer](Velaptor.Graphics.Renderers.ITextureRenderer.md 'Velaptor.Graphics.Renderers.ITextureRenderer') | Renders textures to the screen. | + diff --git a/docs/api/Velaptor.Graphics.md b/docs/api/Velaptor.Graphics.md index 81dfc0e9..afa5527c 100644 --- a/docs/api/Velaptor.Graphics.md +++ b/docs/api/Velaptor.Graphics.md @@ -30,3 +30,4 @@ title: Velaptor.Graphics | :--- | :--- | | [ColorGradient](Velaptor.Graphics.ColorGradient.md 'Velaptor.Graphics.ColorGradient') | Represents the type of gradient a color can. | | [RenderEffects](Velaptor.Graphics.RenderEffects.md 'Velaptor.Graphics.RenderEffects') | Adds basic effects to a texture when rendered. | + diff --git a/docs/api/Velaptor.Hardware.SystemDisplay.md b/docs/api/Velaptor.Hardware.SystemDisplay.md index 4ce960b0..cbca14b6 100644 --- a/docs/api/Velaptor.Hardware.SystemDisplay.md +++ b/docs/api/Velaptor.Hardware.SystemDisplay.md @@ -188,4 +188,4 @@ public int Width { get; set; } ``` #### Property Value -[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') \ No newline at end of file +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') diff --git a/docs/api/Velaptor.Hardware.md b/docs/api/Velaptor.Hardware.md index 56f8d66b..b87f0ccc 100644 --- a/docs/api/Velaptor.Hardware.md +++ b/docs/api/Velaptor.Hardware.md @@ -9,3 +9,4 @@ title: Velaptor.Hardware | Structs | | | :--- | :--- | | [SystemDisplay](Velaptor.Hardware.SystemDisplay.md 'Velaptor.Hardware.SystemDisplay') | Holds information about a single display in the system. | + diff --git a/docs/api/Velaptor.IDrawable.md b/docs/api/Velaptor.IDrawable.md index d0522e36..c1782f76 100644 --- a/docs/api/Velaptor.IDrawable.md +++ b/docs/api/Velaptor.IDrawable.md @@ -27,4 +27,4 @@ Renders the object. ```csharp void Render(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.IPlatform.md b/docs/api/Velaptor.IPlatform.md index 0030f8d5..2f6c5075 100644 --- a/docs/api/Velaptor.IPlatform.md +++ b/docs/api/Velaptor.IPlatform.md @@ -54,4 +54,4 @@ bool Is64BitProcess { get; } ``` #### Property Value -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') \ No newline at end of file +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/docs/api/Velaptor.IUpdatable.md b/docs/api/Velaptor.IUpdatable.md index f12a4255..509b75f6 100644 --- a/docs/api/Velaptor.IUpdatable.md +++ b/docs/api/Velaptor.IUpdatable.md @@ -34,4 +34,4 @@ void Update(Velaptor.FrameTime frameTime); `frameTime` [FrameTime](Velaptor.FrameTime.md 'Velaptor.FrameTime') -The amount of time that has passed for the current frame. \ No newline at end of file +The amount of time that has passed for the current frame. diff --git a/docs/api/Velaptor.Input.Exceptions.InvalidInputException.md b/docs/api/Velaptor.Input.Exceptions.InvalidInputException.md index 060fdf90..77d15413 100644 --- a/docs/api/Velaptor.Input.Exceptions.InvalidInputException.md +++ b/docs/api/Velaptor.Input.Exceptions.InvalidInputException.md @@ -64,4 +64,4 @@ public InvalidInputException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Input.Exceptions.NoKeyboardException.md b/docs/api/Velaptor.Input.Exceptions.NoKeyboardException.md index 135c26b1..5b06adbc 100644 --- a/docs/api/Velaptor.Input.Exceptions.NoKeyboardException.md +++ b/docs/api/Velaptor.Input.Exceptions.NoKeyboardException.md @@ -64,4 +64,4 @@ public NoKeyboardException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Input.Exceptions.NoMouseException.md b/docs/api/Velaptor.Input.Exceptions.NoMouseException.md index 2e3c70d2..fa2c6fae 100644 --- a/docs/api/Velaptor.Input.Exceptions.NoMouseException.md +++ b/docs/api/Velaptor.Input.Exceptions.NoMouseException.md @@ -64,4 +64,4 @@ public NoMouseException(string message); `message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') -The message that describes the error. \ No newline at end of file +The message that describes the error. diff --git a/docs/api/Velaptor.Input.Exceptions.md b/docs/api/Velaptor.Input.Exceptions.md index 0583146c..2b58a449 100644 --- a/docs/api/Velaptor.Input.Exceptions.md +++ b/docs/api/Velaptor.Input.Exceptions.md @@ -11,3 +11,4 @@ title: Velaptor.Input.Exceptions | [InvalidInputException](Velaptor.Input.Exceptions.InvalidInputException.md 'Velaptor.Input.Exceptions.InvalidInputException') | Occurs when invalid input has occured. | | [NoKeyboardException](Velaptor.Input.Exceptions.NoKeyboardException.md 'Velaptor.Input.Exceptions.NoKeyboardException') | Occurs when a keyboard has not been detected in the system. | | [NoMouseException](Velaptor.Input.Exceptions.NoMouseException.md 'Velaptor.Input.Exceptions.NoMouseException') | Occurs when a mouse has not been detected in the system. | + diff --git a/docs/api/Velaptor.Input.IAppInput_TState_.md b/docs/api/Velaptor.Input.IAppInput_TState_.md index 5bcdedeb..a1effc7b 100644 --- a/docs/api/Velaptor.Input.IAppInput_TState_.md +++ b/docs/api/Velaptor.Input.IAppInput_TState_.md @@ -33,5 +33,5 @@ TState GetState(); ``` #### Returns -[TState](Velaptor.Input.IAppInput_TState_.md#Velaptor.Input.IAppInput_TState_.TState 'Velaptor.Input.IAppInput.TState') -The state of the input. \ No newline at end of file +[TState](Velaptor.Input.IAppInput_TState_.md#tstate 'Velaptor.Input.IAppInput.TState') +The state of the input. diff --git a/docs/api/Velaptor.Input.KeyCode.md b/docs/api/Velaptor.Input.KeyCode.md index 86a1f9d9..82ec15ce 100644 --- a/docs/api/Velaptor.Input.KeyCode.md +++ b/docs/api/Velaptor.Input.KeyCode.md @@ -729,4 +729,4 @@ The Y key. `Z` 90 -The Z key. \ No newline at end of file +The Z key. diff --git a/docs/api/Velaptor.Input.KeyEventArgs.md b/docs/api/Velaptor.Input.KeyEventArgs.md index 658d8ef1..59e811df 100644 --- a/docs/api/Velaptor.Input.KeyEventArgs.md +++ b/docs/api/Velaptor.Input.KeyEventArgs.md @@ -46,4 +46,4 @@ public Velaptor.Input.KeyCode Key { get; } ``` #### Property Value -[KeyCode](Velaptor.Input.KeyCode.md 'Velaptor.Input.KeyCode') \ No newline at end of file +[KeyCode](Velaptor.Input.KeyCode.md 'Velaptor.Input.KeyCode') diff --git a/docs/api/Velaptor.Input.KeyboardState.md b/docs/api/Velaptor.Input.KeyboardState.md index c05fd6af..db4c382a 100644 --- a/docs/api/Velaptor.Input.KeyboardState.md +++ b/docs/api/Velaptor.Input.KeyboardState.md @@ -118,7 +118,7 @@ A list of the keys that are currently in the down position. ### IsKeyDown(KeyCode) -Returns a value indicating whether the given [key](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key 'Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key') is in the down position. +Returns a value indicating whether the given [key](Velaptor.Input.KeyboardState.md#key 'Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key') is in the down position. ```csharp public bool IsKeyDown(Velaptor.Input.KeyCode key); @@ -133,13 +133,13 @@ The key to check. #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -`true` if the given [key](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key 'Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key') is in the down position. +`true` if the given [key](Velaptor.Input.KeyboardState.md#key 'Velaptor.Input.KeyboardState.IsKeyDown(Velaptor.Input.KeyCode).key') is in the down position. ### IsKeyUp(KeyCode) -Returns a value indicating whether the given [key](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key 'Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key') is in the up position. +Returns a value indicating whether the given [key](Velaptor.Input.KeyboardState.md#key 'Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key') is in the up position. ```csharp public bool IsKeyUp(Velaptor.Input.KeyCode key); @@ -154,7 +154,7 @@ The key to check. #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -`true` if the given [key](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key 'Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key') is in the up position. +`true` if the given [key](Velaptor.Input.KeyboardState.md#key 'Velaptor.Input.KeyboardState.IsKeyUp(Velaptor.Input.KeyCode).key') is in the up position. @@ -267,7 +267,7 @@ The character that matches the given key. ### SetKeyState(KeyCode, bool) -Sets the state of the given [key](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode,bool).key 'Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode, bool).key') to the given [state](Velaptor.Input.KeyboardState.md#Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode,bool).state 'Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode, bool).state') value. +Sets the state of the given [key](Velaptor.Input.KeyboardState.md#key 'Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode, bool).key') to the given [state](Velaptor.Input.KeyboardState.md#state 'Velaptor.Input.KeyboardState.SetKeyState(Velaptor.Input.KeyCode, bool).state') value. ```csharp public void SetKeyState(Velaptor.Input.KeyCode key, bool state); @@ -284,4 +284,4 @@ The key to set the state to. `state` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -The state of the key. \ No newline at end of file +The state of the key. diff --git a/docs/api/Velaptor.Input.MouseButton.md b/docs/api/Velaptor.Input.MouseButton.md index 13116c22..943469b3 100644 --- a/docs/api/Velaptor.Input.MouseButton.md +++ b/docs/api/Velaptor.Input.MouseButton.md @@ -30,4 +30,4 @@ Represents the middle mouse button. `RightButton` 1 -Represents the right mouse button. \ No newline at end of file +Represents the right mouse button. diff --git a/docs/api/Velaptor.Input.MouseScrollDirection.md b/docs/api/Velaptor.Input.MouseScrollDirection.md index c87ac26a..45516d47 100644 --- a/docs/api/Velaptor.Input.MouseScrollDirection.md +++ b/docs/api/Velaptor.Input.MouseScrollDirection.md @@ -30,4 +30,4 @@ The mouse wheel scrolling in the down direction. `ScrollUp` 2 -The mouse wheel scrolling in the up direction. \ No newline at end of file +The mouse wheel scrolling in the up direction. diff --git a/docs/api/Velaptor.Input.MouseState.md b/docs/api/Velaptor.Input.MouseState.md index 26c63e44..bbe7caf4 100644 --- a/docs/api/Velaptor.Input.MouseState.md +++ b/docs/api/Velaptor.Input.MouseState.md @@ -80,7 +80,7 @@ True if any buttons are in the down position. ### GetButtonState(MouseButton) -Returns a value indicating whether the state for the given [mouseButton](Velaptor.Input.MouseState.md#Velaptor.Input.MouseState.GetButtonState(Velaptor.Input.MouseButton).mouseButton 'Velaptor.Input.MouseState.GetButtonState(Velaptor.Input.MouseButton).mouseButton') +Returns a value indicating whether the state for the given [mouseButton](Velaptor.Input.MouseState.md#mousebutton 'Velaptor.Input.MouseState.GetButtonState(Velaptor.Input.MouseButton).mouseButton') is in the down or up position. ```csharp @@ -172,7 +172,7 @@ The Y position relative to the top left corner of the window. ### IsButtonDown(MouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.Input.MouseState.md#Velaptor.Input.MouseState.IsButtonDown(Velaptor.Input.MouseButton).button 'Velaptor.Input.MouseState.IsButtonDown(Velaptor.Input.MouseButton).button') +Returns a value indicating whether the given mouse [button](Velaptor.Input.MouseState.md#button 'Velaptor.Input.MouseState.IsButtonDown(Velaptor.Input.MouseButton).button') is in the down position. ```csharp @@ -194,7 +194,7 @@ True if the mouse button is in the down position. ### IsButtonUp(MouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.Input.MouseState.md#Velaptor.Input.MouseState.IsButtonUp(Velaptor.Input.MouseButton).button 'Velaptor.Input.MouseState.IsButtonUp(Velaptor.Input.MouseButton).button') +Returns a value indicating whether the given mouse [button](Velaptor.Input.MouseState.md#button 'Velaptor.Input.MouseState.IsButtonUp(Velaptor.Input.MouseButton).button') is in the up position. ```csharp @@ -299,4 +299,4 @@ public bool IsRightButtonUp(); #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') -`true` if the button is up. \ No newline at end of file +`true` if the button is up. diff --git a/docs/api/Velaptor.Input.md b/docs/api/Velaptor.Input.md index 9ab8cf85..b3968ea6 100644 --- a/docs/api/Velaptor.Input.md +++ b/docs/api/Velaptor.Input.md @@ -21,3 +21,4 @@ title: Velaptor.Input | [KeyCode](Velaptor.Input.KeyCode.md 'Velaptor.Input.KeyCode') | Specifies key codes and modifiers in US keyboard layout. | | [MouseButton](Velaptor.Input.MouseButton.md 'Velaptor.Input.MouseButton') | Represents the buttons on a mouse. | | [MouseScrollDirection](Velaptor.Input.MouseScrollDirection.md 'Velaptor.Input.MouseScrollDirection') | Represents the different scroll directions of a mouse. | + diff --git a/docs/api/Velaptor.NativeInterop.ImGui.IImGuiInvoker.md b/docs/api/Velaptor.NativeInterop.ImGui.IImGuiInvoker.md index 93a87a56..3998c1f8 100644 --- a/docs/api/Velaptor.NativeInterop.ImGui.IImGuiInvoker.md +++ b/docs/api/Velaptor.NativeInterop.ImGui.IImGuiInvoker.md @@ -111,7 +111,7 @@ True if an item was chosen. ### Button(string) -Creates a button with the given [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.Button(string).label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Button(string).label'). +Creates a button with the given [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Button(string).label'). ```csharp void Button(string label); @@ -128,7 +128,7 @@ The button label. ### CalcTextSize(string) -Calculates the size of the given [text](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.CalcTextSize(string).text 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.CalcTextSize(string).text'). +Calculates the size of the given [text](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#text 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.CalcTextSize(string).text'). ```csharp System.Numerics.Vector2 CalcTextSize(string text); @@ -149,7 +149,7 @@ The size of the text described by the X representing the width and the Y represe ### Checkbox(string, bool) -Creates a checkbox with the given [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.Checkbox(string,bool).label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Checkbox(string, bool).label'). +Creates a checkbox with the given [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Checkbox(string, bool).label'). ```csharp bool Checkbox(string label, ref bool v); @@ -300,7 +300,7 @@ True if the mouse is hovering over the item. ### IsMouseDown(ImGuiMouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button') is in the down state. +Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button') is in the down state. ```csharp bool IsMouseDown(ImGuiNET.ImGuiMouseButton button); @@ -321,7 +321,7 @@ True if the mouse is in the down state. ### IsMouseDragging(ImGuiMouseButton) -Gets a value indicating whether a window is being dragged by the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button'). +Gets a value indicating whether a window is being dragged by the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button'). ```csharp bool IsMouseDragging(ImGuiNET.ImGuiMouseButton button); @@ -342,7 +342,7 @@ True if the window is being dragged. ### IsMouseReleased(ImGuiMouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button') is in the released state. +Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button') is in the released state. ```csharp bool IsMouseReleased(ImGuiNET.ImGuiMouseButton button); @@ -407,7 +407,7 @@ void PopStyleColor(); ### PopStyleColor(int) -Pops the most recent style colors a total number of times by the given [count](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.PopStyleColor(int).count 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PopStyleColor(int).count'). +Pops the most recent style colors a total number of times by the given [count](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#count 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PopStyleColor(int).count'). ```csharp void PopStyleColor(int count); @@ -475,7 +475,7 @@ The id of the scope. ### PushStyleColor(ImGuiCol, Vector4) -Pushes the color using the given [col](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol,System.Numerics.Vector4).col 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).col') to the current style described by the given [idx](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol,System.Numerics.Vector4).idx 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).idx'). +Pushes the color using the given [col](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#col 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).col') to the current style described by the given [idx](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#idx 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).idx'). ```csharp void PushStyleColor(ImGuiNET.ImGuiCol idx, System.Numerics.Vector4 col); @@ -499,7 +499,7 @@ The color to push. ### PushStyleVar(ImGuiStyleVar, float) Temporarily modifies the style of [ImGuiNET.ImGui](https://docs.microsoft.com/en-us/dotnet/api/ImGuiNET.ImGui 'ImGuiNET.ImGui') by applying a style to a part of -the GUI dictated by the given [idx](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar,float).idx 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).idx') with the given [val](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar,float).val 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).val'). +the GUI dictated by the given [idx](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#idx 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).idx') with the given [val](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#val 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).val'). ```csharp void PushStyleVar(ImGuiNET.ImGuiStyleVar idx, float val); @@ -558,7 +558,7 @@ The amount of spacing between the controls. ### Selectable(string, bool) -Returns a value indicating whether the given item [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.Selectable(string,bool).label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Selectable(string, bool).label') is selectable. +Returns a value indicating whether the given item [label](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Selectable(string, bool).label') is selectable. ```csharp bool Selectable(string label, bool selected); @@ -722,7 +722,7 @@ void Text(string fmt); The text to display. #### Remarks -The [fmt](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.Text(string).fmt 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Text(string).fmt') can take syntax for formatting values such as: +The [fmt](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#fmt 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Text(string).fmt') can take syntax for formatting values such as: - Numerical Formatting You can control how numeric values are displayed, including the number of decimal places, whether to use scientific notation, whether to include a thousand separator, and more. @@ -737,4 +737,4 @@ The [fmt](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.I - Custom Formatting You can define your own format strings to control how certain types of objects are displayed. can escape a brace by adding another brace. -ple: {{ and }} will display as { and }. \ No newline at end of file +ple: {{ and }} will display as { and }. diff --git a/docs/api/Velaptor.NativeInterop.ImGui.ImGuiInvoker.md b/docs/api/Velaptor.NativeInterop.ImGui.ImGuiInvoker.md index f154230a..8c95997b 100644 --- a/docs/api/Velaptor.NativeInterop.ImGui.ImGuiInvoker.md +++ b/docs/api/Velaptor.NativeInterop.ImGui.ImGuiInvoker.md @@ -119,7 +119,7 @@ True if an item was chosen. ### Button(string) -Creates a button with the given [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.Button(string).label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Button(string).label'). +Creates a button with the given [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Button(string).label'). ```csharp public void Button(string label); @@ -138,7 +138,7 @@ Implements [Button(string)](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velapt ### CalcTextSize(string) -Calculates the size of the given [text](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.CalcTextSize(string).text 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.CalcTextSize(string).text'). +Calculates the size of the given [text](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#text 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.CalcTextSize(string).text'). ```csharp public System.Numerics.Vector2 CalcTextSize(string text); @@ -161,7 +161,7 @@ The size of the text described by the X representing the width and the Y represe ### Checkbox(string, bool) -Creates a checkbox with the given [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.Checkbox(string,bool).label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Checkbox(string, bool).label'). +Creates a checkbox with the given [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Checkbox(string, bool).label'). ```csharp public bool Checkbox(string label, ref bool v); @@ -332,7 +332,7 @@ True if the mouse is hovering over the item. ### IsMouseDown(ImGuiMouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button') is in the down state. +Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDown(ImGuiNET.ImGuiMouseButton).button') is in the down state. ```csharp public bool IsMouseDown(ImGuiNET.ImGuiMouseButton button); @@ -355,7 +355,7 @@ True if the mouse is in the down state. ### IsMouseDragging(ImGuiMouseButton) -Gets a value indicating whether a window is being dragged by the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button'). +Gets a value indicating whether a window is being dragged by the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseDragging(ImGuiNET.ImGuiMouseButton).button'). ```csharp public bool IsMouseDragging(ImGuiNET.ImGuiMouseButton button); @@ -378,7 +378,7 @@ True if the window is being dragged. ### IsMouseReleased(ImGuiMouseButton) -Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button') is in the released state. +Returns a value indicating whether the given mouse [button](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#button 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.IsMouseReleased(ImGuiNET.ImGuiMouseButton).button') is in the released state. ```csharp public bool IsMouseReleased(ImGuiNET.ImGuiMouseButton button); @@ -453,7 +453,7 @@ Implements [PopStyleColor()](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velap ### PopStyleColor(int) -Pops the most recent style colors a total number of times by the given [count](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.PopStyleColor(int).count 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PopStyleColor(int).count'). +Pops the most recent style colors a total number of times by the given [count](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#count 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PopStyleColor(int).count'). ```csharp public void PopStyleColor(int count); @@ -529,7 +529,7 @@ Implements [PushID(string)](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velapt ### PushStyleColor(ImGuiCol, Vector4) -Pushes the color using the given [col](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol,System.Numerics.Vector4).col 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).col') to the current style described by the given [idx](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol,System.Numerics.Vector4).idx 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).idx'). +Pushes the color using the given [col](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#col 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).col') to the current style described by the given [idx](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#idx 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleColor(ImGuiNET.ImGuiCol, System.Numerics.Vector4).idx'). ```csharp public void PushStyleColor(ImGuiNET.ImGuiCol idx, System.Numerics.Vector4 col); @@ -555,7 +555,7 @@ Implements [PushStyleColor(ImGuiCol, Vector4)](Velaptor.NativeInterop.ImGui.IImG ### PushStyleVar(ImGuiStyleVar, float) Temporarily modifies the style of [ImGuiNET.ImGui](https://docs.microsoft.com/en-us/dotnet/api/ImGuiNET.ImGui 'ImGuiNET.ImGui') by applying a style to a part of -the GUI dictated by the given [idx](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar,float).idx 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).idx') with the given [val](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar,float).val 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).val'). +the GUI dictated by the given [idx](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#idx 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).idx') with the given [val](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#val 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.PushStyleVar(ImGuiNET.ImGuiStyleVar, float).val'). ```csharp public void PushStyleVar(ImGuiNET.ImGuiStyleVar idx, float val); @@ -620,7 +620,7 @@ Implements [SameLine(float, float)](Velaptor.NativeInterop.ImGui.IImGuiInvoker.m ### Selectable(string, bool) -Returns a value indicating whether the given item [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.Selectable(string,bool).label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Selectable(string, bool).label') is selectable. +Returns a value indicating whether the given item [label](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#label 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Selectable(string, bool).label') is selectable. ```csharp public bool Selectable(string label, bool selected); @@ -800,7 +800,7 @@ The text to display. Implements [Text(string)](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md#Velaptor.NativeInterop.ImGui.IImGuiInvoker.Text(string) 'Velaptor.NativeInterop.ImGui.IImGuiInvoker.Text(string)') #### Remarks -The [fmt](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.ImGui.ImGuiInvoker.Text(string).fmt 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Text(string).fmt') can take syntax for formatting values such as: +The [fmt](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#fmt 'Velaptor.NativeInterop.ImGui.ImGuiInvoker.Text(string).fmt') can take syntax for formatting values such as: - Numerical Formatting You can control how numeric values are displayed, including the number of decimal places, whether to use scientific notation, whether to include a thousand separator, and more. @@ -815,4 +815,4 @@ The [fmt](Velaptor.NativeInterop.ImGui.ImGuiInvoker.md#Velaptor.NativeInterop.Im - Custom Formatting You can define your own format strings to control how certain types of objects are displayed. can escape a brace by adding another brace. -ple: {{ and }} will display as { and }. \ No newline at end of file +ple: {{ and }} will display as { and }. diff --git a/docs/api/Velaptor.NativeInterop.ImGui.md b/docs/api/Velaptor.NativeInterop.ImGui.md index 9f7fc99b..4a104f6d 100644 --- a/docs/api/Velaptor.NativeInterop.ImGui.md +++ b/docs/api/Velaptor.NativeInterop.ImGui.md @@ -13,3 +13,4 @@ title: Velaptor.NativeInterop.ImGui | Interfaces | | | :--- | :--- | | [IImGuiInvoker](Velaptor.NativeInterop.ImGui.IImGuiInvoker.md 'Velaptor.NativeInterop.ImGui.IImGuiInvoker') | Invokes [ImGuiNET.ImGui](https://docs.microsoft.com/en-us/dotnet/api/ImGuiNET.ImGui 'ImGuiNET.ImGui') functions. | + diff --git a/docs/api/Velaptor.OpenGL.Exceptions.BufferNotInitializedException.md b/docs/api/Velaptor.OpenGL.Exceptions.BufferNotInitializedException.md index f40d3d54..701e2c18 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.BufferNotInitializedException.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.BufferNotInitializedException.md @@ -70,4 +70,4 @@ The message that describes the error. `innerException` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') -The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. \ No newline at end of file +The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. diff --git a/docs/api/Velaptor.OpenGL.Exceptions.GLException.md b/docs/api/Velaptor.OpenGL.Exceptions.GLException.md index 8bd1eed0..3ab5a5ef 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.GLException.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.GLException.md @@ -70,4 +70,4 @@ The message that describes the error. `innerException` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') -The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. \ No newline at end of file +The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. diff --git a/docs/api/Velaptor.OpenGL.Exceptions.ShaderCompileException.md b/docs/api/Velaptor.OpenGL.Exceptions.ShaderCompileException.md index b39cd8e0..3987aa5f 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.ShaderCompileException.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.ShaderCompileException.md @@ -70,4 +70,4 @@ The message that describes the error. `innerException` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') -The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. \ No newline at end of file +The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. diff --git a/docs/api/Velaptor.OpenGL.Exceptions.ShaderLinkException.md b/docs/api/Velaptor.OpenGL.Exceptions.ShaderLinkException.md index 9b9768c7..03d82f37 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.ShaderLinkException.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.ShaderLinkException.md @@ -70,4 +70,4 @@ The message that describes the error. `innerException` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') -The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. \ No newline at end of file +The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. diff --git a/docs/api/Velaptor.OpenGL.Exceptions.ShaderNotInitializedException.md b/docs/api/Velaptor.OpenGL.Exceptions.ShaderNotInitializedException.md index c74ef891..f14a3ee8 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.ShaderNotInitializedException.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.ShaderNotInitializedException.md @@ -70,4 +70,4 @@ The message that describes the error. `innerException` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') -The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. \ No newline at end of file +The [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception') instance that caused the current exception. diff --git a/docs/api/Velaptor.OpenGL.Exceptions.md b/docs/api/Velaptor.OpenGL.Exceptions.md index 031f7634..38b8b2f8 100644 --- a/docs/api/Velaptor.OpenGL.Exceptions.md +++ b/docs/api/Velaptor.OpenGL.Exceptions.md @@ -13,3 +13,4 @@ title: Velaptor.OpenGL.Exceptions | [ShaderCompileException](Velaptor.OpenGL.Exceptions.ShaderCompileException.md 'Velaptor.OpenGL.Exceptions.ShaderCompileException') | Thrown when there is an issue compiling a shader. | | [ShaderLinkException](Velaptor.OpenGL.Exceptions.ShaderLinkException.md 'Velaptor.OpenGL.Exceptions.ShaderLinkException') | Thrown when there is an issue linking a shader. | | [ShaderNotInitializedException](Velaptor.OpenGL.Exceptions.ShaderNotInitializedException.md 'Velaptor.OpenGL.Exceptions.ShaderNotInitializedException') | Thrown when a shader has not been initialized. | + diff --git a/docs/api/Velaptor.Platform.md b/docs/api/Velaptor.Platform.md index 03c2052d..6097693d 100644 --- a/docs/api/Velaptor.Platform.md +++ b/docs/api/Velaptor.Platform.md @@ -29,7 +29,7 @@ Gets the current platform of the system. public System.Runtime.InteropServices.OSPlatform CurrentPlatform { get; } ``` -Implements [CurrentPlatform](Velaptor.IPlatform.md#Velaptor.IPlatform.CurrentPlatform 'Velaptor.IPlatform.CurrentPlatform') +Implements [CurrentPlatform](Velaptor.IPlatform.md#currentplatform 'Velaptor.IPlatform.CurrentPlatform') #### Property Value [System.Runtime.InteropServices.OSPlatform](https://docs.microsoft.com/en-us/dotnet/api/System.Runtime.InteropServices.OSPlatform 'System.Runtime.InteropServices.OSPlatform') @@ -44,7 +44,7 @@ Gets a value indicating whether the system is a 32 bit process. public bool Is32BitProcess { get; } ``` -Implements [Is32BitProcess](Velaptor.IPlatform.md#Velaptor.IPlatform.Is32BitProcess 'Velaptor.IPlatform.Is32BitProcess') +Implements [Is32BitProcess](Velaptor.IPlatform.md#is32bitprocess 'Velaptor.IPlatform.Is32BitProcess') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -59,7 +59,7 @@ Gets a value indicating whether the system is a 64 bit process. public bool Is64BitProcess { get; } ``` -Implements [Is64BitProcess](Velaptor.IPlatform.md#Velaptor.IPlatform.Is64BitProcess 'Velaptor.IPlatform.Is64BitProcess') +Implements [Is64BitProcess](Velaptor.IPlatform.md#is64bitprocess 'Velaptor.IPlatform.Is64BitProcess') #### Property Value -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') \ No newline at end of file +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/docs/api/Velaptor.Scene.IScene.md b/docs/api/Velaptor.Scene.IScene.md index 5ffeb35e..41b761c3 100644 --- a/docs/api/Velaptor.Scene.IScene.md +++ b/docs/api/Velaptor.Scene.IScene.md @@ -102,7 +102,7 @@ void LoadContent(); ### Resize(SizeU) -Updates the [WindowSize](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.WindowSize 'Velaptor.Scene.IScene.WindowSize'). +Updates the [WindowSize](Velaptor.Scene.IScene.md#windowsize 'Velaptor.Scene.IScene.WindowSize'). ```csharp void Resize(Velaptor.SizeU size); @@ -123,4 +123,4 @@ Unloads the scene's content. ```csharp void UnloadContent(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Scene.ISceneManager.md b/docs/api/Velaptor.Scene.ISceneManager.md index bcbb9ed1..317490d7 100644 --- a/docs/api/Velaptor.Scene.ISceneManager.md +++ b/docs/api/Velaptor.Scene.ISceneManager.md @@ -153,7 +153,7 @@ void PreviousScene(); ### RemoveScene(Guid) -Removes the scene that matches the given [sceneId](Velaptor.Scene.ISceneManager.md#Velaptor.Scene.ISceneManager.RemoveScene(System.Guid).sceneId 'Velaptor.Scene.ISceneManager.RemoveScene(System.Guid).sceneId'). +Removes the scene that matches the given [sceneId](Velaptor.Scene.ISceneManager.md#sceneid 'Velaptor.Scene.ISceneManager.RemoveScene(System.Guid).sceneId'). ```csharp void RemoveScene(System.Guid sceneId); @@ -187,7 +187,7 @@ The new size. ### SceneExists(Guid) -Returns a value indicating whether a scene exists that matches the given [id](Velaptor.Scene.ISceneManager.md#Velaptor.Scene.ISceneManager.SceneExists(System.Guid).id 'Velaptor.Scene.ISceneManager.SceneExists(System.Guid).id'). +Returns a value indicating whether a scene exists that matches the given [id](Velaptor.Scene.ISceneManager.md#id 'Velaptor.Scene.ISceneManager.SceneExists(System.Guid).id'). ```csharp bool SceneExists(System.Guid id); @@ -208,7 +208,7 @@ The ID of the scene. ### SetSceneAsActive(Guid) -Sets a scene that matches the given [id](Velaptor.Scene.ISceneManager.md#Velaptor.Scene.ISceneManager.SetSceneAsActive(System.Guid).id 'Velaptor.Scene.ISceneManager.SetSceneAsActive(System.Guid).id') to be the active scene. +Sets a scene that matches the given [id](Velaptor.Scene.ISceneManager.md#id 'Velaptor.Scene.ISceneManager.SetSceneAsActive(System.Guid).id') to be the active scene. ```csharp void SetSceneAsActive(System.Guid id); @@ -232,4 +232,4 @@ Unloads the scene manager content and added scenes. ```csharp void UnloadContent(); -``` \ No newline at end of file +``` diff --git a/docs/api/Velaptor.Scene.SceneBase.md b/docs/api/Velaptor.Scene.SceneBase.md index d2afea61..2e7fae88 100644 --- a/docs/api/Velaptor.Scene.SceneBase.md +++ b/docs/api/Velaptor.Scene.SceneBase.md @@ -32,7 +32,7 @@ Gets the unique ID of the scene. public System.Guid Id { get; } ``` -Implements [Id](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.Id 'Velaptor.Scene.IScene.Id') +Implements [Id](Velaptor.Scene.IScene.md#id 'Velaptor.Scene.IScene.Id') #### Property Value [System.Guid](https://docs.microsoft.com/en-us/dotnet/api/System.Guid 'System.Guid') @@ -47,7 +47,7 @@ Gets the name of the scene. public bool IsLoaded { get; set; } ``` -Implements [IsLoaded](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.IsLoaded 'Velaptor.Scene.IScene.IsLoaded') +Implements [IsLoaded](Velaptor.Scene.IScene.md#isloaded 'Velaptor.Scene.IScene.IsLoaded') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -62,7 +62,7 @@ Gets the name of the scene. public string Name { get; set; } ``` -Implements [Name](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.Name 'Velaptor.Scene.IScene.Name') +Implements [Name](Velaptor.Scene.IScene.md#name 'Velaptor.Scene.IScene.Name') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -77,7 +77,7 @@ Gets the center of the window. public System.Drawing.Point WindowCenter { get; } ``` -Implements [WindowCenter](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.WindowCenter 'Velaptor.Scene.IScene.WindowCenter') +Implements [WindowCenter](Velaptor.Scene.IScene.md#windowcenter 'Velaptor.Scene.IScene.WindowCenter') #### Property Value [System.Drawing.Point](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Point 'System.Drawing.Point') @@ -92,7 +92,7 @@ Gets the size of the window. public Velaptor.SizeU WindowSize { get; set; } ``` -Implements [WindowSize](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.WindowSize 'Velaptor.Scene.IScene.WindowSize') +Implements [WindowSize](Velaptor.Scene.IScene.md#windowsize 'Velaptor.Scene.IScene.WindowSize') #### Property Value [SizeU](Velaptor.SizeU.md 'Velaptor.SizeU') @@ -138,7 +138,7 @@ Implements [Render()](Velaptor.IDrawable.md#Velaptor.IDrawable.Render() 'Velapto ### Resize(SizeU) -Updates the [WindowSize](Velaptor.Scene.IScene.md#Velaptor.Scene.IScene.WindowSize 'Velaptor.Scene.IScene.WindowSize'). +Updates the [WindowSize](Velaptor.Scene.IScene.md#windowsize 'Velaptor.Scene.IScene.WindowSize'). ```csharp public virtual void Resize(Velaptor.SizeU size); @@ -182,4 +182,4 @@ public virtual void Update(Velaptor.FrameTime frameTime); The amount of time that has passed for the current frame. -Implements [Update(FrameTime)](Velaptor.IUpdatable.md#Velaptor.IUpdatable.Update(Velaptor.FrameTime) 'Velaptor.IUpdatable.Update(Velaptor.FrameTime)') \ No newline at end of file +Implements [Update(FrameTime)](Velaptor.IUpdatable.md#Velaptor.IUpdatable.Update(Velaptor.FrameTime) 'Velaptor.IUpdatable.Update(Velaptor.FrameTime)') diff --git a/docs/api/Velaptor.Scene.md b/docs/api/Velaptor.Scene.md index 4a4bfba8..51f09a4e 100644 --- a/docs/api/Velaptor.Scene.md +++ b/docs/api/Velaptor.Scene.md @@ -14,3 +14,4 @@ title: Velaptor.Scene | :--- | :--- | | [IScene](Velaptor.Scene.IScene.md 'Velaptor.Scene.IScene') | Represents a single scene that can be rendered to the screen. | | [ISceneManager](Velaptor.Scene.ISceneManager.md 'Velaptor.Scene.ISceneManager') | Manages scenes by loading and unloading content, updating, and rendering scenes. | + diff --git a/docs/api/Velaptor.SizeU.md b/docs/api/Velaptor.SizeU.md index b3f67000..c893ab1e 100644 --- a/docs/api/Velaptor.SizeU.md +++ b/docs/api/Velaptor.SizeU.md @@ -7,7 +7,7 @@ title: Velaptor.SizeU #### SizeU Struct -Stores an ordered pair of [unsigned](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned') integers, which specify a [Width](Velaptor.SizeU.md#Velaptor.SizeU.Width 'Velaptor.SizeU.Width') and [Height](Velaptor.SizeU.md#Velaptor.SizeU.Height 'Velaptor.SizeU.Height'). +Stores an ordered pair of [unsigned](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned') integers, which specify a [Width](Velaptor.SizeU.md#width 'Velaptor.SizeU.Width') and [Height](Velaptor.SizeU.md#height 'Velaptor.SizeU.Height'). ```csharp public readonly struct SizeU : @@ -65,4 +65,4 @@ public uint Width { get; set; } ``` #### Property Value -[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') \ No newline at end of file +[System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') diff --git a/docs/api/Velaptor.StateOfWindow.md b/docs/api/Velaptor.StateOfWindow.md index aca02eb1..6d14ac43 100644 --- a/docs/api/Velaptor.StateOfWindow.md +++ b/docs/api/Velaptor.StateOfWindow.md @@ -39,4 +39,4 @@ This is also known as .iconified. `Normal` 0 -The window is in the normal state. \ No newline at end of file +The window is in the normal state. diff --git a/docs/api/Velaptor.UI.IWindow.md b/docs/api/Velaptor.UI.IWindow.md index a11d1c8b..71d69607 100644 --- a/docs/api/Velaptor.UI.IWindow.md +++ b/docs/api/Velaptor.UI.IWindow.md @@ -354,4 +354,4 @@ Executed after the window has been unloaded. #### Returns [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') -A [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') representing the result of the asynchronous operation. \ No newline at end of file +A [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') representing the result of the asynchronous operation. diff --git a/docs/api/Velaptor.UI.MouseMoveEventArgs.md b/docs/api/Velaptor.UI.MouseMoveEventArgs.md index 403d2ad2..647d1ba1 100644 --- a/docs/api/Velaptor.UI.MouseMoveEventArgs.md +++ b/docs/api/Velaptor.UI.MouseMoveEventArgs.md @@ -65,4 +65,4 @@ public System.Drawing.Point LocalPos { get; } ``` #### Property Value -[System.Drawing.Point](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Point 'System.Drawing.Point') \ No newline at end of file +[System.Drawing.Point](https://docs.microsoft.com/en-us/dotnet/api/System.Drawing.Point 'System.Drawing.Point') diff --git a/docs/api/Velaptor.UI.Window.md b/docs/api/Velaptor.UI.Window.md index c05251ac..a800d959 100644 --- a/docs/api/Velaptor.UI.Window.md +++ b/docs/api/Velaptor.UI.Window.md @@ -31,7 +31,7 @@ be automatically cleared before rendering any textures. public bool AutoClearBuffer { get; set; } ``` -Implements [AutoClearBuffer](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.AutoClearBuffer 'Velaptor.UI.IWindow.AutoClearBuffer') +Implements [AutoClearBuffer](Velaptor.UI.IWindow.md#autoclearbuffer 'Velaptor.UI.IWindow.AutoClearBuffer') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -58,7 +58,7 @@ Gets or sets a value indicating whether the scenes should be automatically loade public bool AutoSceneLoading { get; set; } ``` -Implements [AutoSceneLoading](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.AutoSceneLoading 'Velaptor.UI.IWindow.AutoSceneLoading') +Implements [AutoSceneLoading](Velaptor.UI.IWindow.md#autosceneloading 'Velaptor.UI.IWindow.AutoSceneLoading') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -73,7 +73,7 @@ Gets or sets a value indicating whether the scenes should be automatically rende public bool AutoSceneRendering { get; set; } ``` -Implements [AutoSceneRendering](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.AutoSceneRendering 'Velaptor.UI.IWindow.AutoSceneRendering') +Implements [AutoSceneRendering](Velaptor.UI.IWindow.md#autoscenerendering 'Velaptor.UI.IWindow.AutoSceneRendering') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -88,7 +88,7 @@ Gets or sets a value indicating whether the scenes should be automatically unloa public bool AutoSceneUnloading { get; set; } ``` -Implements [AutoSceneUnloading](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.AutoSceneUnloading 'Velaptor.UI.IWindow.AutoSceneUnloading') +Implements [AutoSceneUnloading](Velaptor.UI.IWindow.md#autosceneunloading 'Velaptor.UI.IWindow.AutoSceneUnloading') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -103,7 +103,7 @@ Gets or sets a value indicating whether the scenes should be automatically updat public bool AutoSceneUpdating { get; set; } ``` -Implements [AutoSceneUpdating](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.AutoSceneUpdating 'Velaptor.UI.IWindow.AutoSceneUpdating') +Implements [AutoSceneUpdating](Velaptor.UI.IWindow.md#autosceneupdating 'Velaptor.UI.IWindow.AutoSceneUpdating') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -118,7 +118,7 @@ Gets or sets the [System.Action](https://docs.microsoft.com/en-us/dotnet/api/Sys public System.Action? Draw { get; set; } ``` -Implements [Draw](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Draw 'Velaptor.UI.IWindow.Draw') +Implements [Draw](Velaptor.UI.IWindow.md#draw 'Velaptor.UI.IWindow.Draw') #### Property Value [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[FrameTime](Velaptor.FrameTime.md 'Velaptor.FrameTime')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') @@ -133,7 +133,7 @@ Gets the frames per second that the main loop is running at. public float Fps { get; } ``` -Implements [Fps](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Fps 'Velaptor.UI.IWindow.Fps') +Implements [Fps](Velaptor.UI.IWindow.md#fps 'Velaptor.UI.IWindow.Fps') #### Property Value [System.Single](https://docs.microsoft.com/en-us/dotnet/api/System.Single 'System.Single') @@ -148,7 +148,7 @@ Gets or sets the height of the window. public uint Height { get; set; } ``` -Implements [Height](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Height 'Velaptor.UI.IWindow.Height') +Implements [Height](Velaptor.UI.IWindow.md#height 'Velaptor.UI.IWindow.Height') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -163,7 +163,7 @@ Gets or sets the [System.Action](https://docs.microsoft.com/en-us/dotnet/api/Sys public System.Action? Initialize { get; set; } ``` -Implements [Initialize](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Initialize 'Velaptor.UI.IWindow.Initialize') +Implements [Initialize](Velaptor.UI.IWindow.md#initialize 'Velaptor.UI.IWindow.Initialize') #### Property Value [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') @@ -178,7 +178,7 @@ Gets a value indicating whether the window has been initialized. public bool Initialized { get; } ``` -Implements [Initialized](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Initialized 'Velaptor.UI.IWindow.Initialized') +Implements [Initialized](Velaptor.UI.IWindow.md#initialized 'Velaptor.UI.IWindow.Initialized') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -193,7 +193,7 @@ Gets or sets a value indicating whether the mouse cursor is visible. public bool MouseCursorVisible { get; set; } ``` -Implements [MouseCursorVisible](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.MouseCursorVisible 'Velaptor.UI.IWindow.MouseCursorVisible') +Implements [MouseCursorVisible](Velaptor.UI.IWindow.md#mousecursorvisible 'Velaptor.UI.IWindow.MouseCursorVisible') #### Property Value [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') @@ -208,7 +208,7 @@ Gets or sets the position of the window. public System.Numerics.Vector2 Position { get; set; } ``` -Implements [Position](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Position 'Velaptor.UI.IWindow.Position') +Implements [Position](Velaptor.UI.IWindow.md#position 'Velaptor.UI.IWindow.Position') #### Property Value [System.Numerics.Vector2](https://docs.microsoft.com/en-us/dotnet/api/System.Numerics.Vector2 'System.Numerics.Vector2') @@ -223,7 +223,7 @@ Gets the scene manager. public Velaptor.Scene.ISceneManager SceneManager { get; } ``` -Implements [SceneManager](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.SceneManager 'Velaptor.UI.IWindow.SceneManager') +Implements [SceneManager](Velaptor.UI.IWindow.md#scenemanager 'Velaptor.UI.IWindow.SceneManager') #### Property Value [ISceneManager](Velaptor.Scene.ISceneManager.md 'Velaptor.Scene.ISceneManager') @@ -238,7 +238,7 @@ Gets or sets the title of the window. public string Title { get; set; } ``` -Implements [Title](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Title 'Velaptor.UI.IWindow.Title') +Implements [Title](Velaptor.UI.IWindow.md#title 'Velaptor.UI.IWindow.Title') #### Property Value [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') @@ -253,7 +253,7 @@ Gets or sets the type of border that the [IWindow](Velaptor.UI.IWindow.md 'Velap public Velaptor.WindowBorder TypeOfBorder { get; set; } ``` -Implements [TypeOfBorder](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.TypeOfBorder 'Velaptor.UI.IWindow.TypeOfBorder') +Implements [TypeOfBorder](Velaptor.UI.IWindow.md#typeofborder 'Velaptor.UI.IWindow.TypeOfBorder') #### Property Value [WindowBorder](Velaptor.WindowBorder.md 'Velaptor.WindowBorder') @@ -268,7 +268,7 @@ Gets or sets the [System.Action](https://docs.microsoft.com/en-us/dotnet/api/Sys public System.Action? Uninitialize { get; set; } ``` -Implements [Uninitialize](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Uninitialize 'Velaptor.UI.IWindow.Uninitialize') +Implements [Uninitialize](Velaptor.UI.IWindow.md#uninitialize 'Velaptor.UI.IWindow.Uninitialize') #### Property Value [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action') @@ -283,7 +283,7 @@ Gets or sets the [System.Action](https://docs.microsoft.com/en-us/dotnet/api/Sys public System.Action? Update { get; set; } ``` -Implements [Update](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Update 'Velaptor.UI.IWindow.Update') +Implements [Update](Velaptor.UI.IWindow.md#update 'Velaptor.UI.IWindow.Update') #### Property Value [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[FrameTime](Velaptor.FrameTime.md 'Velaptor.FrameTime')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') @@ -298,7 +298,7 @@ Gets or sets the value of how often the update and render calls are invoked in t public int UpdateFrequency { get; set; } ``` -Implements [UpdateFrequency](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.UpdateFrequency 'Velaptor.UI.IWindow.UpdateFrequency') +Implements [UpdateFrequency](Velaptor.UI.IWindow.md#updatefrequency 'Velaptor.UI.IWindow.UpdateFrequency') #### Property Value [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') @@ -313,7 +313,7 @@ Gets or sets the width of the window. public uint Width { get; set; } ``` -Implements [Width](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.Width 'Velaptor.UI.IWindow.Width') +Implements [Width](Velaptor.UI.IWindow.md#width 'Velaptor.UI.IWindow.Width') #### Property Value [System.UInt32](https://docs.microsoft.com/en-us/dotnet/api/System.UInt32 'System.UInt32') @@ -328,7 +328,7 @@ Gets or sets the state of the window. public Velaptor.StateOfWindow WindowState { get; set; } ``` -Implements [WindowState](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.WindowState 'Velaptor.UI.IWindow.WindowState') +Implements [WindowState](Velaptor.UI.IWindow.md#windowstate 'Velaptor.UI.IWindow.WindowState') #### Property Value [StateOfWindow](Velaptor.StateOfWindow.md 'Velaptor.StateOfWindow') @@ -343,7 +343,7 @@ Gets or sets the [System.Action](https://docs.microsoft.com/en-us/dotnet/api/Sys public System.Action? WinResize { get; set; } ``` -Implements [WinResize](Velaptor.UI.IWindow.md#Velaptor.UI.IWindow.WinResize 'Velaptor.UI.IWindow.WinResize') +Implements [WinResize](Velaptor.UI.IWindow.md#winresize 'Velaptor.UI.IWindow.WinResize') #### Property Value [System.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1')[SizeU](Velaptor.SizeU.md 'Velaptor.SizeU')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System.Action`1') @@ -415,4 +415,4 @@ Implements [ShowAsync(Action, Action)](Velaptor.UI.IWindow.md#Velaptor.UI.IWindo A [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') representing the result of the asynchronous operation. #### Remarks -This runs the window on another thread. \ No newline at end of file +This runs the window on another thread. diff --git a/docs/api/Velaptor.UI.md b/docs/api/Velaptor.UI.md index 98afc918..1314f2e8 100644 --- a/docs/api/Velaptor.UI.md +++ b/docs/api/Velaptor.UI.md @@ -17,3 +17,4 @@ title: Velaptor.UI | Interfaces | | | :--- | :--- | | [IWindow](Velaptor.UI.IWindow.md 'Velaptor.UI.IWindow') | Provides the core of an application window which facilitates how the<br/>window behaves, its state and the ability to be used in various types<br/>of applications. | + diff --git a/docs/api/Velaptor.WindowBorder.md b/docs/api/Velaptor.WindowBorder.md index 13b87178..1c653980 100644 --- a/docs/api/Velaptor.WindowBorder.md +++ b/docs/api/Velaptor.WindowBorder.md @@ -33,4 +33,4 @@ resized programmatically. `Resizable` 0 The window has a resizable border. A window with a resizable border can be resized -by the user or programmatically. \ No newline at end of file +by the user or programmatically. diff --git a/docs/api/Velaptor.md b/docs/api/Velaptor.md index c9a56b74..f46c1b72 100644 --- a/docs/api/Velaptor.md +++ b/docs/api/Velaptor.md @@ -16,7 +16,7 @@ title: Velaptor | Structs | | | :--- | :--- | | [FrameTime](Velaptor.FrameTime.md 'Velaptor.FrameTime') | Holds timing information for a loop iteration. | -| [SizeU](Velaptor.SizeU.md 'Velaptor.SizeU') | Stores an ordered pair of [unsigned](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned') integers, which specify a [Width](Velaptor.SizeU.md#Velaptor.SizeU.Width 'Velaptor.SizeU.Width') and [Height](Velaptor.SizeU.md#Velaptor.SizeU.Height 'Velaptor.SizeU.Height'). | +| [SizeU](Velaptor.SizeU.md 'Velaptor.SizeU') | Stores an ordered pair of [unsigned](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned 'https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/keywords/unsigned') integers, which specify a [Width](Velaptor.SizeU.md#width 'Velaptor.SizeU.Width') and [Height](Velaptor.SizeU.md#height 'Velaptor.SizeU.Height'). | | Interfaces | | | :--- | :--- | @@ -28,3 +28,4 @@ title: Velaptor | :--- | :--- | | [StateOfWindow](Velaptor.StateOfWindow.md 'Velaptor.StateOfWindow') | The different states that a [Window](Velaptor.UI.Window.md 'Velaptor.UI.Window') can be in. | | [WindowBorder](Velaptor.WindowBorder.md 'Velaptor.WindowBorder') | The different kinds of borders that a [IWindow](Velaptor.UI.IWindow.md 'Velaptor.UI.IWindow') can have. | +