diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2e6c3342659f95340ad5d80fc8401a1521e6d50b --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# VRClient + +## Folder Structure +* blender - Blender 2.8 source code +* cyclesphi - static library (think client for rendering on HPC) +* cesnet - static library (getter for camera position, setter for rendering buffer) +* vrclient - main application +* scripts - bash scripts for building and running of vrclient + +## First Build with Downloading of source code (Linux) +* prerequisities: CMake, GCC +* create the working folder and download and run the script: [download_vrclient.sh](scripts/download_vrclient.sh) + +## Build (Linux) +* goto the working folder and run the script: [build_vrclient_gcc.sh](scripts/build_vrclient_gcc.sh) + +## Run (Linux) +* goto the working folder and run the script: [run_vrclient_gcc.sh](scripts/run_vrclient_gcc.sh) + +## CESNET API [cesnet.h](cesnet/cesnet.h) +``` +// camera view matrix +void cesnet_get_camera_matrices(float view_matrix[12]); + +// rendering buffer - results in YUV I420 format +void cesnet_set_render_buffer_yuv_i420(unsigned char *y, unsigned char *u, unsigned char *v); + +// flag for breaking of rendering/cyclesphi loop +bool cesnet_is_required_exit(); + +// info about resolution and base position of camera +void cesnet_init_info_buffer(int width, int height, float view_matrix[12]); +```