Skip to content

Commit 968c731

Browse files
committed
Clarification in README, properly inlay functions
1 parent 9a02088 commit 968c731

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,23 @@ SharedGL is an OpenGL implementation that enables 3D acceleration for Windows an
2424

2525
# Getting started
2626

27-
The following libraries are required for building the server (and client) on Linux:
27+
The following libraries are required for building the server on Linux:
2828
- libepoxy
2929
- SDL2
30-
- libx11
3130

32-
The following script builds: `sglrenderer` and `libGL` for Linux:
31+
The following script builds `sglrenderer` for Linux:
3332
```bash
3433
git clone https://github.com/dmaivel/sharedgl.git
3534
cd sharedgl
3635
mkdir build
3736
cd build
3837
cmake ..
39-
cmake --build . --config Release
38+
cmake --build . --target sglrenderer --config Release
4039
```
4140

42-
If on Windows (Visual Studio required), you must specify that you only want to build the library, `sharedglXX.dll`:
43-
```
44-
cmake --build . --target sharedgl-core --config Release
45-
```
41+
If you also wish to build the client library for Linux, `libx11` is required. Build with `--target sharedgl-core`.
4642

47-
For detailed build instructions for Windows, visit the [Windows section](#windows-in-a-vm).
43+
For detailed build instructions for Windows, visit the [Windows section](#windows-in-a-vm). The renderer/server is only supported on Linux hosts.
4844

4945
### Build options
5046

@@ -156,6 +152,10 @@ There are two ways to install the library on windows:
156152
```
157153
158154
## Linux
155+
156+
> [!IMPORTANT]
157+
> The following sections discuss using the *client library*, not the *renderer/server*. If your intention is to only accelerate Windows guests, you may disregard this section as all you need to do is run the renderer, no additional libraries required (other than the dependencies).
158+
159159
For your OpenGL application to communicate with the server, the client library must be specified in your library path. Upon exporting, any program you run in the terminal where you inputted this command will run with the SGL binary.
160160
161161
```bash

‎src/server/processor.c‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ static void scramble(int *arr, int n)
115115
}
116116
}
117117

118-
static FORCEINLINE void wait_shm(void *p, int *client_id)
118+
static FORCEINLINE inline void wait_shm(void *p, int *client_id)
119119
{
120120
/*
121121
* not only wait for a submit from a specific client,
@@ -272,7 +272,7 @@ static void sgl_net_get_fifo_upload(void *p, int *client_id, bool *ready_to_rend
272272
}
273273
}
274274

275-
static FORCEINLINE void wait_net(void *p, int *client_id, struct net_context *net_ctx, struct sgl_cmd_processor_args args,
275+
static FORCEINLINE inline void wait_net(void *p, int *client_id, struct net_context *net_ctx, struct sgl_cmd_processor_args args,
276276
size_t framebuffer_size, size_t fifo_size, int width, int height)
277277
{
278278
bool ready_to_render = false;

0 commit comments

Comments
 (0)