Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document more about the API differences #177

Open
Gnimuc opened this issue Jan 11, 2019 · 1 comment
Open

Document more about the API differences #177

Gnimuc opened this issue Jan 11, 2019 · 1 comment

Comments

@Gnimuc
Copy link
Contributor

Gnimuc commented Jan 11, 2019

Read the GLFW documentation for detailed instructions on how to use the library. The Julia interface is almost identical to the underlying C interface, with a few notable differences:

Clipboard (glfwGetClipboard, glfwSetClipboard) and time (glfwGetTime, glfwSetTime) functions have been omitted because Julia's standard library already supports similar functionality.

glfwInit and glfwTerminate are called automatically using the init and atexit functions. While it is okay to still call them explicitly, it is redundant and not required.

GLFW.jl has evolved a lot, but some changes are not mentioned in README. Some callback interfaces become more Julian, for example, error callback signature is different from the original GLFW's: https://www.glfw.org/docs/3.0/group__error.html. Although it can be easily fixed when one triggered the error, I guess it would be more convenient if those changes are well documented.

@musm
Copy link
Contributor

musm commented Aug 14, 2020

Yeah agreed, I think other than the callback interface everything else is quite close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants