MCPcopy Index your code
hub / github.com/LWJGLX/lwjgl3-awt

github.com/LWJGLX/lwjgl3-awt @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
306 symbols 521 edges 26 files 54 documented · 18%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Build-and-publish Actions Status Maven Release Maven Snapshot

This library allows for using OpenGL and Vulkan LWJGL 3 surfaces in AWT (and by extension, Swing) frames. Works with macOS, Windows, and Linux.

What does it get me?

Support for OpenGL: - creating OpenGL 3.0 and 3.2 core/compatibility contexts (including debug/forward compatible) - OpenGL ES contexts - floating-point and sRGB pixel formats - multisampled framebuffers (also with different number of color samples - Nvidia only) - v-sync/swap control - context flush control - robust buffer access (with application/share-group isolation) - sync'ing buffer swaps over multiple windows and cards - Nvidia only - delay before swap - Nvidia only

Support for Vulkan: - Vulkan 1.0, 1.1, 1.2, 1.3, 1.4 - MoltenVK support

Note about compatibility: The minimum macOS version for OpenGL is 10.5, and the minimum for Vulkan is 10.11, since Vulkan runs on top of the Metal API introduced in that version.

How to use

Full code samples: - AWTTest - AWTThreadTest - Core32Test - SimpleDemo (Vulkan)

OpenGL

In order to create an OpenGL 3.3 core profile context with 4 sample MSAA, use:

JFrame frame = new JFrame("AWT test");
frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
frame.setLayout(new BorderLayout());
GLData data = new GLData();
data.majorVersion = 3;
data.minorVersion = 3;
data.profile = GLData.Profile.CORE;
data.samples = 4;
frame.add(new AWTGLCanvas(data) {
  public void initGL() {
  }
  public void paintGL() {
  }
});

Vulkan

if (!AWTVK.isPlatformSupported()) {
    throw new RuntimeException("Platform not supported.");
}

JFrame frame = new JFrame("AWT test");
frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
frame.setLayout(new BorderLayout());
frame.setPreferredSize(new Dimension(600, 600));
Canvas canvas = new Canvas();
frame.add(canvas, BorderLayout.CENTER);
frame.pack(); // Packing causes the canvas to be lockable, and is the earliest time it can be used

long surface = AWTVK.create(canvas, instance);

// Do things with the surface

frame.setVisible(true);
frame.addWindowListener(new WindowAdapter() {
    @Override
    public void windowClosing(WindowEvent e) {
        super.windowClosing(e);

        // Destroy the surface to prevent leaks and errors
        KHRSurface.vkDestroySurfaceKHR(instance, surface, null);
}});

Extension points exported contracts — how you extend this code

PlatformGLCanvas (Interface)
Interface for platform-specific implementations of AWTGLCanvas. @author Kai Burjack [6 implementers]
src/org/lwjgl/opengl/awt/PlatformGLCanvas.java
PlatformVKCanvas (Interface)
Interface for platform-specific implementations of AWTVKCanvas. @author Kai Burjack @deprecated see {@link AWTV [6 implementers]
src/org/lwjgl/vulkan/awt/PlatformVKCanvas.java

Core symbols most depended-on inside this repo

setBackground
called by 16
src/org/lwjgl/awthacks/NonClearGraphics2D.java
create
called by 8
src/org/lwjgl/opengl/awt/PlatformGLCanvas.java
swapBuffers
called by 6
src/org/lwjgl/opengl/awt/PlatformGLCanvas.java
create
called by 6
src/org/lwjgl/vulkan/awt/PlatformVKCanvas.java
render
called by 5
src/org/lwjgl/opengl/awt/AWTGLCanvas.java
getFramebufferWidth
called by 5
src/org/lwjgl/opengl/awt/AWTGLCanvas.java
getFramebufferHeight
called by 5
src/org/lwjgl/opengl/awt/AWTGLCanvas.java
dispose
called by 5
src/org/lwjgl/opengl/awt/PlatformGLCanvas.java

Shape

Method 270
Class 31
Enum 3
Interface 2

Languages

Java100%

Modules by API surface

src/org/lwjgl/awthacks/NonClearGraphics2D.java68 symbols
src/org/lwjgl/awthacks/NonClearGraphics.java40 symbols
test/org/lwjgl/vulkan/awt/ClearScreenDemo.java25 symbols
src/org/lwjgl/opengl/awt/AWTGLCanvas.java18 symbols
src/org/lwjgl/opengl/awt/PlatformLinuxGLCanvas.java16 symbols
test/org/lwjgl/opengl/awt/CompareScreenshotTest.java13 symbols
src/org/lwjgl/opengl/awt/PlatformWin32GLCanvas.java13 symbols
src/org/lwjgl/opengl/awt/PlatformMacOSXGLCanvas.java13 symbols
test/org/lwjgl/opengl/awt/AWTThreadTest.java10 symbols
src/org/lwjgl/opengl/awt/PlatformGLCanvas.java10 symbols
src/org/lwjgl/vulkan/awt/PlatformMacOSXVKCanvas.java8 symbols
test/org/lwjgl/opengl/awt/DrawOnDemandTest.java7 symbols

For agents

$ claude mcp add lwjgl3-awt \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact