Skip to content

Commit

Permalink
resolving requests v1
Browse files Browse the repository at this point in the history
  • Loading branch information
lumi2021 committed Aug 18, 2024
1 parent a7d7c3a commit 133ea41
Show file tree
Hide file tree
Showing 17 changed files with 119 additions and 55 deletions.
3 changes: 2 additions & 1 deletion website/blog/2024-02-14-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ image: https://i.imgur.com/mErPwqL.png
hide_table_of_contents: false
---

Blogs will still be reinplemented! sorry!
🚧 UNDER CONSTRUCTION 🚧 \
Blogs will be back soon!

<!-- truncate -->
5 changes: 5 additions & 0 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_label: "FAQ"
---

# Frequently Asked Questions
8 changes: 0 additions & 8 deletions website/docs/getStarted.md

This file was deleted.

4 changes: 4 additions & 0 deletions website/docs/hlu_tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position" : 2,
"label" : "HLU Tutorials"
}
7 changes: 7 additions & 0 deletions website/docs/hlu_tutorials/hlu_tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# HLU Tutorials

We're still working on our Windowing & Input High Level
Utilities (HLU) tutorials!

You can get the gist of how HLU works by reading through
the [OpenGL tutorials](../opengl/opengl.md)
49 changes: 49 additions & 0 deletions website/docs/hlu_tutorials/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Troubleshooting

## Common exceptions

### `PlatformNotSupportedException: Couldn't find a suitable windowing platform.`
When attempting to call Window.Create, a `PlatformNotSupportedException` is thrown with a message indicating that the windowing system couldn't find a windowing platform.

**Cause:** \
There are multiple causes for this particular exception, however the most common are:

- The underlying windowing API could not be loaded;
- The underlying windowing API does not support the current platform;
- Resolution;

**How to fix:**
- Ensure you have the Microsoft Visual C++ Redisributables installed;
- Ensure the underlying API is present on the system

Silk.NET should do a good job of copying the appropriate native libraries upon build by default, and will search your PATH for them if not present in the output directory.

However, in some environments this system is not reliable and you will need to provide the binaries yourself. To do so:

Download or build your chosen native API (you will be able to find instructions on how to do this in their repositories):

GLFW: https://github.com/glfw/glfw \
SDL: https://github.com/libsdl-org/SDL

Retreive the resultant binary files and place them in your program's output directory.
Ensure the file names match what Silk.NET expects, as illustrated by the table below:

| Platform | Underlying API | File Name |
|---------------|--------------------|-----------------|
| Windows | GLFW 3.3 | glfw3.dll |
| Linux | GLFW 3.3 | libglfw.so.3 |
| MacOS | GLFW 3.3 | libglfw.3.dylib |
| Android | SDL 2.0.14 | libSDL2.so |
| iOS | SDL 2.0.14 | libSDL2.a |

Ensure the underlying API supports the current platform
You should be using a version of Silk.NET and an appropriate windowing backend that support the platform you are trying to run on. See the below table for first-party support.

| Silk.NET Version | Underlying API | Supported platforms | Packages |
|------------------|----------------|-----------------------|-----------------------------|
| 1.X | GLFW 3.3 | Windows, MacOS, Linux | Silk.NET.Windowing.Desktop |
| 2.X | GLFW 3.3 | Windows, MacOS, Linux | Silk.NET.Windowing.Glfw |
| 2.X | GLFW 3.3 | Android, iOS[1] | Silk.NET.Windowing.Sdl |

[1] Please note that while Windows, MacOS, and Linux support is available using the SDL windowing backend, this is not something the Silk.NET team actively supports.

4 changes: 4 additions & 0 deletions website/docs/miscellaneous/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position" : 3,
"label" : "Miscellaneous"
}
Empty file.
2 changes: 1 addition & 1 deletion website/docs/opengl/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"position" : 2,
"position" : 1,
"label" : "OpenGL"
}
7 changes: 7 additions & 0 deletions website/docs/opengl/opengl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# OpenGL Tutorials

We're still working on the web, text-based walkthroughs of our
example projects. However, the code is already written!

You can check out some examples of using Silk.NET for OpenGL
[here](https://github.com/dotnet/Silk.NET/tree/main/examples).
12 changes: 5 additions & 7 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const darkCodeTheme = themes.dracula;

favicon: 'img/favicon.ico',

organizationName: 'dotnet comunity',
organizationName: '.NET Foundation',
projectName: 'Silk.NET',

presets: [
Expand All @@ -28,14 +28,12 @@ const darkCodeTheme = themes.dracula;
sidebarPath: require.resolve('./sidebars.js'),
showLastUpdateAuthor: true,
showLastUpdateTime: true,
// TOFIX update it to the right repo path
editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/',
editUrl: 'https://github.com/dotnet/Silk.NET/tree/main/website',
},

blog: {
showReadingTime: true,
// Please change this to your repo.
editUrl: 'https://github.com/facebook/docusaurus/edit/main/website/blog/',
editUrl: 'https://github.com/dotnet/Silk.NET/tree/main/website/blog',
},

theme: {
Expand Down Expand Up @@ -63,7 +61,7 @@ const darkCodeTheme = themes.dracula;
items: [
{
label: 'Docs',
to: '/docs/getStarted',
to: '/docs/opengl/helloWindow',
position: 'left'
},

Expand All @@ -75,7 +73,7 @@ const darkCodeTheme = themes.dracula;

{
label: 'FAQ',
to : '/',
to : '/docs/faq',
position: 'left'
},

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import React from "react";
import styles from "./AllinOneSolution.module.scss";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faTrowelBricks, faMobileScreen, faFaceSmile } from "@fortawesome/free-solid-svg-icons";
import { faGear, faMobileScreen, faFaceSmile } from "@fortawesome/free-solid-svg-icons";

export default function AllInOneSolution(): JSX.Element {

Expand All @@ -13,7 +13,7 @@ export default function AllInOneSolution(): JSX.Element {
<img src={'img/xplatpromo.png'} draggable={"false"}></img>

<div className={styles.item}>
<span><FontAwesomeIcon icon={faTrowelBricks}></FontAwesomeIcon></span>
<span><FontAwesomeIcon icon={faGear}></FontAwesomeIcon></span>
<p>First-party bindings for over 17 individual APIs</p>
</div>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ html[data-theme='dark'] .githubWigdget .header .discussionsTitle svg {

.githubWigdget .content {
position: relative;
margin: 5px 15px 50px 15px;
margin: 10px 20px 50px 20px;
p {
margin: 0;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ export default function JoinTheConversation(): JSX.Element {

<div className={styles.content}>

<p>Active and fun community;</p>
<p>Quick answers and <span className={styles.channelLink}>help</span> channel;</p>
<p>Active and fun community</p>
<p>Easy & quick answers to questions</p>
<p>News and announcements</p>

</div>
Expand Down Expand Up @@ -56,15 +56,9 @@ export default function JoinTheConversation(): JSX.Element {
</div>

<div className={styles.content}>
<p>Contribute with:</p>
<div className={styles.list}>
<p>💡 ideas;</p>
<p>⏫ suggestions;</p>
<p>🐞 bug reports;</p>
</div>
<p>
And the future of Silk.NET directly with the
.NET team!
Get answers to your questions, and participate in the development
by discussing and/or contributing improvements.
</p>
</div>

Expand Down
42 changes: 28 additions & 14 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,18 +1,32 @@
/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
*/
html[data-theme='light'],
html[data-theme='light'] :root {
--ifm-color-primary: #7014eb;
--ifm-color-primary-dark: #6512d3;
--ifm-color-primary-darker: #5f11c8;
--ifm-color-primary-darkest: #4e0ea4;
--ifm-color-primary-light: #7e2ced;
--ifm-color-primary-lighter: #8537ee;
--ifm-color-primary-lightest: #9b5af1;

--ifm-background-color: #e5f9f0;
--ifm-background-surface-color: #D8DEE9;

--ifm-code-font-size: 95%;
}

html[data-theme='dark'],
html[data-theme='dark'] :root {
--ifm-color-primary: #c8a5f7;
--ifm-color-primary-dark: #b17ff4;
--ifm-color-primary-darker: #9a59f0;
--ifm-color-primary-darkest: #8333ed;
--ifm-color-primary-light: #dfcbfa;
--ifm-color-primary-lighter: #f6f1fe;
--ifm-color-primary-lightest: #ffffff;

--ifm-background-color: #3b4252;
--ifm-background-surface-color: #2E3440;

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: rgb(33, 175, 144);
--ifm-color-primary-darker: rgb(31, 165, 136);
--ifm-color-primary-darkest: rgb(26, 136, 112);
--ifm-color-primary-light: rgb(70, 203, 174);
--ifm-color-primary-lighter: rgb(102, 212, 189);
--ifm-color-primary-lightest: rgb(146, 224, 208);
--ifm-code-font-size: 95%;
}

Expand Down
11 changes: 0 additions & 11 deletions website/src/pages/index.module.css
Original file line number Diff line number Diff line change
@@ -1,18 +1,7 @@
@import url('https://fonts.googleapis.com/css2?family=Open+Sans:ital,wght@0,300..800;1,300..800&display=swap');
@import url('https://db.onlinewebfonts.com/c/00d5a78493aed4b11e2584ad7cceee49?family=Gilroy-ExtraBold');

html {
background-color: var(--ifm-background-color);
}

html[data-theme='dark'] {
--ifm-background-color: #3B4252;
--ifm-hero-background-color: #2E3440;
}
html[data-theme='light'] {
--ifm-background-color: white;
--ifm-hero-background-color: whitesmoke;
}

.heroBanner {
text-align: center;
Expand Down
Binary file modified website/static/img/favicon.ico
Binary file not shown.

0 comments on commit 133ea41

Please sign in to comment.