Skip to content

Commit

Permalink
Merge pull request #18 from rladstaetter/patch-1
Browse files Browse the repository at this point in the history
updates readme.md
  • Loading branch information
miho committed Aug 1, 2019
2 parents d156449 + bf2e3c7 commit a89fd9e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ build_me
/src/main/resources/eu/mihosoft/nativefx/nativelibs/

/hs_err*.log

.idea/
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Many features are still missing. We are working on stabilizing the API in the up

There have been efforts to do this before. Why should this approach be any better?

Good question! For now, we use a direct buffer and use the PixelWriter interface to update a WritableImage that displays the content. There's a new [PR](https://github.com/javafxports/openjdk-jfx/pull/472) for the upcoming version of JavaFX (JavaFX 13) which will highly improve the performance of NativeFX once it's released. Early tests show that twe can expect a performance boost of around 50%. For our use cases this is a game changer!
Good question! For now, we use a direct buffer and use the PixelWriter interface to update a WritableImage that displays the content. There's a new [PR](https://github.com/javafxports/openjdk-jfx/pull/472) for the upcoming version of JavaFX (JavaFX 13) which will highly improve the performance of NativeFX once it's released. Early tests show that we can expect a performance boost of around 50%. For our use cases this is a game changer!

If you are willing to use internal APIs you can try [DriftFX](https://github.com/eclipse-efx/efxclipse-drift). Which will work with direct texture sharing instead of slow CPU based buffers. NativeFX is a more conservative approach.

Expand Down Expand Up @@ -107,7 +107,7 @@ That's it!

### Step 1 (compile and run the sample-server)

Make sure Qt is installed properly (libs must be on the PATH). To compile and run the sample-server, do the following (releatrive to the previous project folder):
Make sure Qt is installed properly (libs must be on the PATH). To compile and run the sample-server, do the following (relative to the previous project folder):

#### Bash (Linux/macOS/Cygwin/other Unix shell)

Expand All @@ -117,7 +117,7 @@ Make sure Qt is installed properly (libs must be on the PATH). To compile and ru
cmake ..
make
./nativefx-qt -n _mem_1

#### Windows (CMD)

cd sample-servers/nativefx-qt/
Expand All @@ -130,6 +130,8 @@ Make sure Qt is installed properly (libs must be on the PATH). To compile and ru
If Qt5 cannot be found, let CMake know where to search for Qt, e.g.,

cmake .. -DCMAKE_GENERATOR_PLATFORM=x64 -DQt5_DIR=C:\Qt\5.13.0\msvc2017_64\lib\cmake\Qt5\

Hint: Qt5_Dir has to point to a directory containing 'Qt5Config.cmake' or 'qt5-config.cmake'.

If the last command doesn't work, then check whether the executable is located in `Release\nativefx-qt.exe` without `x64`.

Expand Down

0 comments on commit a89fd9e

Please sign in to comment.