Forum Discussion

🚨 This forum is archived and read-only. To submit a forum post, please visit our new Developer Forum. 🚨
dougui's avatar
dougui
Honored Guest
12 years ago

Is there a API documentation?

Hi,

I may be missing something but I don't find a API documentation. I am Ruby developer and I'm used to have this kind of doc : http://www.ruby-doc.org/core-2.1.1/Array.html. Is there a list of public methods with a description of the behaviour somewhere?

Thanks!

7 Replies

  • If you click "Reference" on the top menu you will see the API docs. Honestly they are pretty out-of-date, but may be good enough to get you started. We've also done a pretty big re-write of the API, so a lot of this stuff will change in the upcoming SDK.
  • Chimyx's avatar
    Chimyx
    Honored Guest
    Is there any announcement about when the upcoming SDK will be available?
  • I'm hoping the new SDK takes the path of a leaner, simpler, C-based: "easy to port to other systems and bind with other languages" SDK. The existing option was honestly the thorn in my side which was enough to put the VR project aside for the time being.
  • "atavener" wrote:
    I'm hoping the new SDK takes the path of a leaner, simpler, C-based: "easy to port to other systems and bind with other languages" SDK. The existing option was honestly the thorn in my side which was enough to put the VR project aside for the time being.


    I've started work on a C interface built into my copy of the SDK. If the next rev of the SDK doesn't contain a C natively, I'll likely resume work on it and produce a release, since it may make it easier for integration into Python modules and the like.
  • midg3t's avatar
    midg3t
    Honored Guest
    First Post - Whoop!

    I pre-ordered the DK2 (I don't own the DK1) - but I am going to start playing with the API in the mean time. One thing I found interesting was the Open Source API Valve is working. Basically it will allow you to interface your game with VR regardless of what hardware your users are using. As far as I know - the only current supported hardware is the Rift (since its for the most part the only piece of kit we have atm) - but as more manufacturers create hardware they will add support. From the Dev Talk I watched the API looks fairly straight forward (and is cross platform compatible).

    Linkin case you should be interested
  • "midg3t" wrote:
    One thing I found interesting was the Open Source API Valve is working. Basically it will allow you to interface your game with VR regardless of what hardware your users are using.


    Oculus has stated a couple of times on the forums that the next SDK version will be released soon and will significantly alter the approach taken to doing distortion. My personal suspicion is that they will be adopting the 'callback' method being used in the Steam VR api, allowing clients to build a lookup texture for distortion, or alternatively build a mesh for performing distortion.

    "midg3t" wrote:
    Linkin case you should be interested


    If you look at the issues for that repository you'll see I've already filed a number of issues against the current version. But then again, I'm a cranky curmudgeon who is capable of finding fault with any piece of code (including my own).

    I've also written up an example application against it and may cover it in the book.