/proxy-vulkan

Proxy Vulkan is an open source to send local Vulkan calls to the cloud.

Primary LanguageCMakeBSD 2-Clause "Simplified" LicenseBSD-2-Clause

Proxy Vulkan

Build Status Build Status

License

Trello URL

Index

Proxy Vulkan 0.2.0

Proxy Vulkan is an open source to send local Vulkan calls to the cloud.

Use the "proxy library" technique to override the Vulkan library so an application will use this one instead of the real. This give us the ability to intercept all the call to the original API and send them to the cloud to run in there.

In contrast to tipical game streaming system that you send the user inputs and the cloud returns you the result image, this system run the application locally but the Vulkan calls are executed at a cloud.

You will be able to execute any Vulkan application with the power of the cloud.

Version: 0.2.0 - Released: 30th October 2020

What's new in 0.2.0?

  • Convert to C++.
  • Use Cap'n Proto to send the data over TCP.

How to Build

Coming soon...

How to Run (in development)

Currently, the IP are hard-coded.

To run the server:

./proxy-vulkan-server

To run the proxy library, for example for the create instance example:

  • Windows:
./create_instance
  • MacOS:
DYLD_LIBRARY_PATH=. ./create_instance
  • Linux
LD_LIBRARY_PATH=. ./create_instance

Requirements

  • C++14 or above compatible compiler.

Dependencies

Future features

Contributing

  • If you find a bug then please report it on GitHub Issues.

  • If you have a feature request, or have written a tool or demo that shows Proxy Vulkan in use, then please get in touch. We'd love to hear from you!

Bugs?

Please add them to the Issue Tracker with as much info as possible, especially source code demonstrating the issue.

Honorable mentions

Coming soon...

License

BSD 2-Clause License

Copyright (c) 2020, Elias Serrano
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
	list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
	this list of conditions and the following disclaimer in the documentation
	and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.