Code Monkey home page Code Monkey logo

funnel's Introduction

Funnel

Screenshot

Funnel is a Syphon server plugin for Unity. It allows Unity to share rendered frames with other applications that supports the Syphon protocol (e.g., MadMapper, VDMX) without introducing any performance loss.

Compatibility Note

This version is redesigned and optimized for the new OpenGL backend (OpenGL Core) and not compatible with the legacy OpenGL backend. If it's required to support legacy OpenGL, use the legacy version instead.

System Requirements

  • Mac OS X 10.8 or later
  • Unity 5.3 or later

This version only supports the 64-bit runtime and the OpenGL Core API mode. The legacy version is available for legacy setups.

Setting Up

  • Download and import the plugin package.
  • Add the Funnel script to a camera that's to be shared.

That's all! It automatically sets up a Syphon server and starts publishing rendered frames towards Syphon client applications.

The name of the Syphon server is set in the following manner:

[Process Name]-[Game Object Name]

It's useful to identify the server on the client side.

Properties

Screen Width/Height, Anti Aliasing - Configures the screen to be sent.

Discard Alpha - Clears the alpha channel with 1.0 (completely opaque) before sending.

Render Mode - Determines how the frame is shared.

  • Send Only - Sends the frame and doesn't keep it. The rendered frame is only available on the client side.
  • Render To Target - Sends the frame and copies it to the render texture.
  • Preview On Game View - Sends the frame and display it on the Game view.

License

Copyright (C) 2013-2016 Keijiro Takahashi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

funnel's People

Contributors

keijiro avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.