Skip to content

Commit

Permalink
Add "how to use" section
Browse files Browse the repository at this point in the history
  • Loading branch information
madwyn committed Aug 5, 2013
1 parent db67654 commit c0acf44
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,20 @@ Cube2Cyl
A panoramic lib, cubic to cylindrical projection conversion

Read more details of implementation here: http://www.wenyanan.com/cube2cyl/

How to use
----------

The Cube2Cyl library is a single header file library, written in C++. There is a demo application included as usage example.

The library takes the following parameters:

Width of the panorama (must be lager than 1)
Height of the panorama (must be lager than 1)
Width of the square input (the input must have a ratio of 1:1)
View portion horizontally, [0.01, 2π]
View portion vertically, [0.01, π]

This library takes any valid parameter and deals the ratio changes automatically. You can use super sampling to generate accurate panorama.

For the maximum performance, using a precomputed map is recommended rather than doing the calculation for each frame.

0 comments on commit c0acf44

Please sign in to comment.