google / dart-glfw

Dart bindings for GLFW, a multiplatform library for creating windows with OpenGL contexts.

Dart bindings to GLFW 3.2.1.

Supports Linux and Windows. OSX is not supported due to inherent incompatibilites in the OSX UI threading model, as well as Apple announcing the discontinuing of support of OpenGL on OSX (https://goo.gl/qQdeQ5).

Steps to generate the bindings

mkdir -p lib/src/generated/
pub run tools/glfw_generator.dart --glfw3_path=<path to glfw3.h>
clang-format -i --style=Google generated/*.{cc,h}
dartfmt -w generated/*.dart
mv generated/* lib/src/generated

Steps to compile the bindings

The previous method for compiling the bindings is no longer available. We are working on a new solution for both Linux and Windows.

In the meantime, the Makefile in the lib/ directory is a good starting point for compiling on Linux.

Notes about the auto-generated bindings

• glfwWindowShouldClose returns an int, rather than a bool, but unlike in C, the expression !(1) returns true so you must explicitly test glfwWindowShouldClose(window) != 1
  • There is also a convenience function
    bool glfwWindowShouldCloseAsBool(GLFWwindow window)

The following functions have changed from the C GLFW API

These changes are due to the C library's use of pointer arguments to return values. See also lib/src/manual_bindings.dart.

• glfwGetVersion
  • Returns a GLFWVersion instance which has major, minor, rev fields.
• glfwGetMonitors
  • Returns a List<GLFWmonitor> instance.
• glfwGetMonitorPos
  • Returns a Point instance.
• glfwGetMonitorPhysicalSize
  • Returns a Rectangle instance with xpos and ypos set to 0.
• glfwGetVideoModes
  • Returns a List<GLFWvidmode> instance.
• glfwGetWindowPos
  • Returns a Point instance.
• glfwGetWindowSize
  • Returns a Rectangle instance with xpos and ypos set to 0.
• glfwGetFramebufferSize
  • Returns a Rectangle instance with xpos and ypos set to 0.
• glfwGetWindowFrameSize
  • Returns a Rectangle instance.
• glfwSetWindowUserPointer
  • pointer parameter is a Dart Object.
• glfwGetWindowUserPointer
  • Returns an Object instance.
• glfwGetCursorPos
  • Returns a Point instance.
• glfwGetJoystickAxes
  • Returns a List<double> instance.
• glfwGetJoystickButtons
  • Returns a List<int> instance.

The following functions are additions to the C GLFW API

• glfwSwapBuffersAsync
  • An async version of glfwSwapBuffers that can be await-ed. This avoids blocking the current isolate while the glfwSwapBuffers call is waiting to finish.

dart-glfw's Issues

vulkan osx

any plans to update to the last glfw supporting vulkan ?

Support Issues

Will this be maintained in the future?

I was wondering if it is possible for dart to be supported by vulkan (and MeltenVK)..
Quite few I know about these stuffs, so it's kind of you to forgive my stupid :)

thanks for your work!

auto-build the native library as part of pub get"

255 does not fit into an unsigned char

import 'package:image/image.dart' show Image, decodeImage;

iconProvider: () => decodeImage(File('example/icon.png').readAsBytesSync()),
// ----------
if (iconProvider != null) {
  final image = iconProvider();
  glfwSetWindowIcon(window, 0, GLFWimage(image.width, image.height, image.getBytes()));
}

error in generated code

Dart_Handle Dart_IntegerToUChar(Dart_Handle integer, unsigned char* value) {
  int64_t actual;
  HandleError(Dart_IntegerToInt64(integer, &actual));

  // here
  if (actual < UCHAR_MAX) { // <- actual <= UCHAR_MAX
    *value = static_cast<unsigned char>(actual);
    return Dart_True();
  } else {
    char buf[50];  // Technically we only need 46 characters for this.
    snprintf(buf, sizeof(buf),
             "%" PRId64 " does not fit into an unsigned char.", actual);
    return Dart_NewApiError(buf);
  }
}

idk it is right, but this solve my problem

Eliminate uses of deprecated CONSTANTS

This package still uses deprecated Dart 1 SCREAMING CAPS CONSTANTS. These will be removed shortly in Dart 2. This rewriting tool can be used to automatically migrate code in most cases: https://github.com/dart-lang/dart2_fix .

Exception while running example on macOS

dart example_es2_window.dart gave this error:

2017-08-27 09:53:59.449 dart[867:11447] WARNING: nextEventMatchingMask should only be called from the Main Thread! This will throw an exception in the future.
2017-08-27 09:53:59.449 dart[867:11447] *** Assertion failure in +[NSUndoManager _endTopLevelGroupings], /Library/Caches/com.apple.xbs/Sources/Foundation/Foundation-1349/Misc.subproj/NSUndoManager.m:363
2017-08-27 09:53:59.538 dart[867:11447] *** Assertion failure in +[NSUndoManager _endTopLevelGroupings], /Library/Caches/com.apple.xbs/Sources/Foundation/Foundation-1349/Misc.subproj/NSUndoManager.m:363
2017-08-27 09:53:59.540 dart[867:11447] *** Terminating app due to uncaught exception 'NSInternalInconsistencyException', reason: '+[NSUndoManager(NSInternal) _endTopLevelGroupings] is only safe to invoke on the main thread.'
*** First throw call stack:
(
	0   CoreFoundation                      0x00007fffc498d7bb __exceptionPreprocess + 171
	1   libobjc.A.dylib                     0x00007fffd90f0a2a objc_exception_throw + 48
	2   CoreFoundation                      0x00007fffc4992312 +[NSException raise:format:arguments:] + 98
	3   Foundation                          0x00007fffc63e5390 -[NSAssertionHandler handleFailureInMethod:object:file:lineNumber:description:] + 195
	4   Foundation                          0x00007fffc636fa93 +[NSUndoManager(NSPrivate) _endTopLevelGroupings] + 170
	5   AppKit                              0x00007fffc25900cf -[NSApplication run] + 1200
	6   libglfw.3.dylib                     0x000000010751af7c initializeAppKit + 1420
	7   libglfw.3.dylib                     0x000libc++abi.dylib: terminating with uncaught exception of type NSException
fish: 'dart example_es2_window.dart' terminated by signal SIGABRT (Abort)

auto-build the native library and binding as part of "pub get"