GLFW.jl icon indicating copy to clipboard operation
GLFW.jl copied to clipboard

Document more about the API differences

Open Gnimuc opened this issue 6 years ago • 1 comments
trafficstars

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.

Gnimuc avatar Jan 11 '19 13:01 Gnimuc

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

musm avatar Aug 14 '20 22:08 musm