From 1ffaba5f7ee6478bce6cf1297a02e0faba130741 Mon Sep 17 00:00:00 2001 From: Benjamin Schaaf Date: Fri, 9 Apr 2021 22:57:14 +1000 Subject: [PATCH] First pass at OpenGL debayering --- data/debayer.frag | 28 ++ data/debayer.vert | 19 ++ gl_quickpreview.c | 216 ++++++++++++++ gl_quickpreview.h | 21 ++ gl_utils.h | 34 +++ main.c | 8 + meson.build | 8 +- process_pipeline.c | 236 +++++++++++++++- process_pipeline.h | 4 + renderdoc/app.h | 688 +++++++++++++++++++++++++++++++++++++++++++++ 10 files changed, 1248 insertions(+), 14 deletions(-) create mode 100644 data/debayer.frag create mode 100644 data/debayer.vert create mode 100644 gl_quickpreview.c create mode 100644 gl_quickpreview.h create mode 100644 gl_utils.h create mode 100644 renderdoc/app.h diff --git a/data/debayer.frag b/data/debayer.frag new file mode 100644 index 0000000..75addcb --- /dev/null +++ b/data/debayer.frag @@ -0,0 +1,28 @@ +precision mediump float; + +uniform sampler2D texture; + +varying vec2 uv1; +varying vec2 uv2; +varying vec2 pixel_coord; + +#define fetch(p) texture2D(texture, p).r + +void main() { + vec4 pixels = vec4( + fetch(uv1), + fetch(vec2(uv1.x, uv2.y)), + fetch(uv2), + fetch(vec2(uv2.x, uv1.y))); + + vec2 arrangement = mod(pixel_coord, 2.0); + + vec2 is_top_left = step(1.0, arrangement); + + vec3 color = mix( + mix(pixels.zyx, pixels.wzy, is_top_left.y), + mix(pixels.yzw, pixels.xyz, is_top_left.y), + is_top_left.x); + + gl_FragColor = vec4(color, 0); +} diff --git a/data/debayer.vert b/data/debayer.vert new file mode 100644 index 0000000..f205536 --- /dev/null +++ b/data/debayer.vert @@ -0,0 +1,19 @@ +precision mediump float; + +attribute vec2 vert; +attribute vec2 tex_coord; + +uniform mat3 transform; +uniform vec2 pixel_size; + +varying vec2 uv1; +varying vec2 uv2; +varying vec2 pixel_coord; + +void main() { + uv1 = tex_coord - pixel_size / 2.0; + uv2 = tex_coord + pixel_size / 2.0; + pixel_coord = uv1 / pixel_size; + + gl_Position = vec4(transform * vec3(vert, 1), 1); +} diff --git a/gl_quickpreview.c b/gl_quickpreview.c new file mode 100644 index 0000000..2bc1a8f --- /dev/null +++ b/gl_quickpreview.c @@ -0,0 +1,216 @@ +#include "camera.h" +#include "gl_quickpreview.h" +#include "gl_utils.h" +#include +#include + +#define VERTEX_ATTRIBUTE 0 +#define TEX_COORD_ATTRIBUTE 1 + +static const GLfloat square_vertices[] = { + -1, -1, + 1, -1, + -1, 1, + 1, 1, +}; + +static const GLfloat square_texcoords[] = { + 1, 1, + 1, 0, + 0, 1, + 0, 0, +}; + +struct _GLQuickPreview { + GLuint frame_buffer; + GLuint program; + GLuint uniform_transform; + GLuint uniform_pixel_size; + GLuint uniform_texture; +}; + +static GLuint load_shader(const char *path, GLenum type) +{ + check_gl(); + + FILE *f = fopen(path, "r"); + + fseek(f, 0, SEEK_END); + GLint size = ftell(f); + char *source = malloc(sizeof(char) * size); + + fseek(f, 0, SEEK_SET); + if (fread(source, size, 1, f) == 0) { + printf("Failed to read shader file\n"); + return 0; + } + + GLuint shader = glCreateShader(type); + assert(shader != 0); + glShaderSource(shader, 1, (const GLchar * const*)&source, &size); + glCompileShader(shader); + check_gl(); + + // Check compile status + GLint success; + glGetShaderiv(shader, GL_COMPILE_STATUS, &success); + if (success == GL_FALSE) { + printf("Shader compilation failed for %s\n", path); + } + + GLint log_length; + glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &log_length); + if (log_length > 0) { + char *log = malloc(sizeof(char) * log_length); + glGetShaderInfoLog(shader, log_length - 1, &log_length, log); + + printf("Shader %s log: %s\n", path, log); + free(log); + } + + free(source); + + return shader; +} + +GLQuickPreview *gl_quick_preview_new() +{ + GLuint frame_buffer; + glGenFramebuffers(1, &frame_buffer); + check_gl(); + + GLuint vert = load_shader("data/debayer.vert", GL_VERTEX_SHADER); + GLuint frag = load_shader("data/debayer.frag", GL_FRAGMENT_SHADER); + + GLuint program = glCreateProgram(); + glAttachShader(program, vert); + glAttachShader(program, frag); + + glBindAttribLocation(program, VERTEX_ATTRIBUTE, "vert"); + check_gl(); + glBindAttribLocation(program, TEX_COORD_ATTRIBUTE, "tex_coord"); + check_gl(); + glLinkProgram(program); + check_gl(); + + GLint success; + glGetProgramiv(program, GL_LINK_STATUS, &success); + if (success == GL_FALSE) { + printf("Program linking failed\n"); + } + + GLint log_length; + glGetProgramiv(program, GL_INFO_LOG_LENGTH, &log_length); + if (log_length > 0) { + char *log = malloc(sizeof(char) * log_length); + glGetProgramInfoLog(program, log_length - 1, &log_length, log); + + printf("Program log: %s\n", log); + free(log); + } + + check_gl(); + + GLQuickPreview *self = malloc(sizeof(GLQuickPreview)); + self->frame_buffer = frame_buffer; + self->program = program; + + self->uniform_transform = glGetUniformLocation(self->program, "transform"); + check_gl(); + + self->uniform_pixel_size = glGetUniformLocation(self->program, "pixel_size"); + check_gl(); + + self->uniform_texture = glGetUniformLocation(self->program, "texture"); + check_gl(); + + return self; +} + +void gl_quick_preview_free(GLQuickPreview *self) +{ + glDeleteFramebuffers(1, &self->frame_buffer); + + free(self); +} + +bool +ql_quick_preview_supports_format(GLQuickPreview *self, const MPPixelFormat format) +{ + return format == MP_PIXEL_FMT_BGGR8; +} + +bool +gl_quick_preview(GLQuickPreview *self, + GLuint dst_id, + const uint32_t dst_width, const uint32_t dst_height, + GLuint source_id, + const uint32_t src_width, const uint32_t src_height, + const MPPixelFormat format, + const uint32_t rotation, + const bool mirrored, + const float *colormatrix, + const uint8_t blacklevel) +{ + assert(ql_quick_preview_supports_format(self, format)); + + glBindFramebuffer(GL_FRAMEBUFFER, self->frame_buffer); + glBindTexture(GL_TEXTURE_2D, dst_id); + glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, dst_id, 0); + check_gl(); + + glViewport(0, 0, dst_width, dst_height); + check_gl(); + + assert(glCheckFramebufferStatus(GL_FRAMEBUFFER) == GL_FRAMEBUFFER_COMPLETE); + + glUseProgram(self->program); + check_gl(); + + GLfloat rotation_list[4] = { 1, 0, -1, 0 }; + int rotation_index = 4 - rotation / 90; + + GLfloat sin_rot = rotation_list[rotation_index]; + GLfloat cos_rot = rotation_list[(rotation_index + 1) % 4]; + GLfloat scale_x = mirrored ? 1 : -1; + GLfloat matrix[9] = { + cos_rot * scale_x, sin_rot, 0, + -sin_rot * scale_x, cos_rot, 0, + 0, 0, 1, + }; + glUniformMatrix3fv(self->uniform_transform, 1, GL_FALSE, matrix); + check_gl(); + + GLfloat pixel_size_x = 1.0f / src_width; + GLfloat pixel_size_y = 1.0f / src_height; + glUniform2f(self->uniform_pixel_size, pixel_size_x, pixel_size_y); + check_gl(); + + glActiveTexture(GL_TEXTURE0); + glBindTexture(GL_TEXTURE_2D, source_id); + glUniform1i(self->uniform_texture, 0); + check_gl(); + + glVertexAttribPointer(VERTEX_ATTRIBUTE, 2, GL_FLOAT, 0, 0, square_vertices); + check_gl(); + glEnableVertexAttribArray(VERTEX_ATTRIBUTE); + check_gl(); + glVertexAttribPointer(TEX_COORD_ATTRIBUTE, 2, GL_FLOAT, 0, 0, square_texcoords); + check_gl(); + glEnableVertexAttribArray(TEX_COORD_ATTRIBUTE); + check_gl(); + glDrawArrays(GL_TRIANGLE_STRIP, 0, 4); + check_gl(); + + // TODO: Render + // glClearColor(0, 0, 1, 0); + // glClear(GL_COLOR_BUFFER_BIT); + + // glBindTexture(GL_TEXTURE_2D, 0); + // glBindFramebuffer(GL_FRAMEBUFFER, 0); + + glUseProgram(0); + check_gl(); + + return true; +} diff --git a/gl_quickpreview.h b/gl_quickpreview.h new file mode 100644 index 0000000..fede8c5 --- /dev/null +++ b/gl_quickpreview.h @@ -0,0 +1,21 @@ +#include "quickpreview.h" +#include +#include +#include + +typedef struct _GLQuickPreview GLQuickPreview; + +GLQuickPreview* gl_quick_preview_new(); +void gl_quick_preview_free(GLQuickPreview *self); + +bool ql_quick_preview_supports_format(GLQuickPreview *self, const MPPixelFormat format); +bool gl_quick_preview(GLQuickPreview *self, + GLuint dst_id, + const uint32_t dst_width, const uint32_t dst_height, + GLuint source_id, + const uint32_t src_width, const uint32_t src_height, + const MPPixelFormat format, + const uint32_t rotation, + const bool mirrored, + const float *colormatrix, + const uint8_t blacklevel); diff --git a/gl_utils.h b/gl_utils.h new file mode 100644 index 0000000..bb4c268 --- /dev/null +++ b/gl_utils.h @@ -0,0 +1,34 @@ +#include + +#define check_gl() __check_gl(__FILE__, __LINE__) + +static void __check_gl(const char *file, int line) +{ + GLenum error = glGetError(); + + const char *name; + switch (error) { + case GL_NO_ERROR: + return; // no error + case GL_INVALID_ENUM: + name = "GL_INVALID_ENUM"; + break; + case GL_INVALID_VALUE: + name = "GL_INVALID_VALUE"; + break; + case GL_INVALID_OPERATION: + name = "GL_INVALID_OPERATION"; + break; + case GL_INVALID_FRAMEBUFFER_OPERATION: + name = "GL_INVALID_FRAMEBUFFER_OPERATION"; + break; + case GL_OUT_OF_MEMORY: + name = "GL_OUT_OF_MEMORY"; + break; + default: + name = "UNKNOWN ERROR!"; + break; + } + + printf("GL error at %s:%d - %s\n", file, line, name); +} diff --git a/main.c b/main.c index 63471bc..dd825fe 100644 --- a/main.c +++ b/main.c @@ -21,6 +21,7 @@ #include "camera_config.h" #include "quickpreview.h" #include "io_pipeline.h" +#include "process_pipeline.h" enum user_control { USER_CONTROL_ISO, USER_CONTROL_SHUTTER }; @@ -686,6 +687,12 @@ on_control_slider_changed(GtkAdjustment *widget, gpointer user_data) } } +static void +on_realize(GtkWidget *window, gpointer *data) +{ + mp_process_pipeline_init_gl(gtk_widget_get_window(window)); +} + int main(int argc, char *argv[]) { @@ -726,6 +733,7 @@ main(int argc, char *argv[]) control_slider = GTK_ADJUSTMENT(gtk_builder_get_object(builder, "control_adj")); control_auto = GTK_WIDGET(gtk_builder_get_object(builder, "control_auto")); + g_signal_connect(window, "realize", G_CALLBACK(on_realize), NULL); g_signal_connect(window, "destroy", G_CALLBACK(gtk_main_quit), NULL); g_signal_connect(shutter, "clicked", G_CALLBACK(on_shutter_clicked), NULL); g_signal_connect(error_close, "clicked", G_CALLBACK(on_error_close_clicked), diff --git a/meson.build b/meson.build index 56df6fe..40f31c6 100644 --- a/meson.build +++ b/meson.build @@ -4,6 +4,8 @@ gtkdep = dependency('gtk+-3.0') tiff = dependency('libtiff-4') zbar = dependency('zbar') threads = dependency('threads') +gl = dependency('gl') +egl = dependency('egl') cc = meson.get_compiler('c') libm = cc.find_library('m', required: false) @@ -31,6 +33,7 @@ executable('megapixels', 'main.c', 'ini.c', 'quickpreview.c', + 'gl_quickpreview.c', 'camera.c', 'device.c', 'pipeline.c', @@ -40,8 +43,9 @@ executable('megapixels', 'zbar_pipeline.c', 'matrix.c', resources, - dependencies : [gtkdep, libm, tiff, zbar, threads], - install : true) + dependencies : [gtkdep, libm, tiff, zbar, threads, gl, egl], + install : true, + link_args : '-Wl,-ldl') install_data(['data/org.postmarketos.Megapixels.desktop'], install_dir : get_option('datadir') / 'applications') diff --git a/process_pipeline.c b/process_pipeline.c index 7a43c59..af14120 100644 --- a/process_pipeline.c +++ b/process_pipeline.c @@ -6,12 +6,18 @@ #include "main.h" #include "config.h" #include "quickpreview.h" +#include "gl_quickpreview.h" #include #include #include #include #include +#include "gl_utils.h" +#include +#include +#include + #define TIFFTAG_FORWARDMATRIX1 50964 static const float colormatrix_srgb[] = { 3.2409, -1.5373, -0.4986, -0.9692, 1.8759, @@ -141,24 +147,230 @@ mp_process_pipeline_sync() mp_pipeline_sync(pipeline); } +#define NUM_BUFFERS 4 + +static GLQuickPreview *gl_quick_preview_state = NULL; + +static EGLDisplay egl_display = EGL_NO_DISPLAY; +static EGLContext egl_context = EGL_NO_CONTEXT; + +// struct buffer { +// GLuint texture_id; +// EGLImage egl_image; +// int dma_fd; +// int dma_stride; +// int dma_offset; +// void *data; +// }; +// static struct buffer input_buffers[NUM_BUFFERS]; +// static struct buffer output_buffers[NUM_BUFFERS]; + +static PFNEGLEXPORTDMABUFIMAGEMESAPROC eglExportDMABUFImageMESA; + +static const char * +egl_get_error_str() +{ + EGLint error = eglGetError(); + switch (error) { + case EGL_SUCCESS: return "EGL_SUCCESS"; + case EGL_NOT_INITIALIZED: return "EGL_NOT_INITIALIZED"; + case EGL_BAD_ACCESS: return "EGL_BAD_ACCESS"; + case EGL_BAD_ALLOC: return "EGL_BAD_ALLOC"; + case EGL_BAD_ATTRIBUTE: return "EGL_BAD_ATTRIBUTE"; + case EGL_BAD_CONTEXT: return "EGL_BAD_CONTEXT"; + case EGL_BAD_CONFIG: return "EGL_BAD_CONFIG"; + case EGL_BAD_CURRENT_SURFACE: return "EGL_BAD_CURRENT_SURFACE"; + case EGL_BAD_DISPLAY: return "EGL_BAD_DISPLAY"; + case EGL_BAD_SURFACE: return "EGL_BAD_SURFACE"; + case EGL_BAD_MATCH: return "EGL_BAD_MATCH"; + case EGL_BAD_PARAMETER: return "EGL_BAD_PARAMETER"; + case EGL_BAD_NATIVE_PIXMAP: return "EGL_BAD_NATIVE_PIXMAP"; + case EGL_BAD_NATIVE_WINDOW: return "EGL_BAD_NATIVE_WINDOW"; + case EGL_CONTEXT_LOST: return "EGL_CONTEXT_LOST"; + } + return "Unknown"; +} + +#define RENDERDOC + +#ifdef RENDERDOC +#include +#include +RENDERDOC_API_1_1_2 *rdoc_api = NULL; +#endif + +static void +init_gl(MPPipeline *pipeline, GdkWindow **window) +{ +#ifdef RENDERDOC + { + void *mod = dlopen("librenderdoc.so", RTLD_NOW | RTLD_NOLOAD); + if (mod) + { + pRENDERDOC_GetAPI RENDERDOC_GetAPI = (pRENDERDOC_GetAPI)dlsym(mod, "RENDERDOC_GetAPI"); + int ret = RENDERDOC_GetAPI(eRENDERDOC_API_Version_1_1_2, (void **)&rdoc_api); + assert(ret == 1); + } + else + { + printf("Renderdoc not found\n"); + } + } +#endif + + GdkDisplay *gdk_display = gdk_window_get_display(*window); + egl_display = eglGetDisplay((EGLNativeDisplayType) gdk_wayland_display_get_wl_display(gdk_display)); + assert(egl_display != EGL_NO_DISPLAY); + + EGLint major, minor; + if (!eglInitialize(egl_display, &major, &minor)) { + printf("Failed to initialize egl: %s\n", egl_get_error_str()); + return; + } + + if (!eglBindAPI(EGL_OPENGL_ES_API)) { + printf("Failed to bind OpenGL ES: %s\n", egl_get_error_str()); + return; + } + + printf("extensions: %s\n", eglQueryString(egl_display, EGL_EXTENSIONS)); + + EGLint config_attrs[1] = { + EGL_NONE + }; + + EGLConfig config; + EGLint num_configs = 0; + if (!eglChooseConfig(egl_display, config_attrs, &config, 1, &num_configs)) { + printf("Failed to pick a egl config: %s\n", egl_get_error_str()); + return; + } + + if (num_configs != 1) { + printf("No egl configs found: %s\n", egl_get_error_str()); + return; + } + + EGLint context_attrs[5] = { + EGL_CONTEXT_CLIENT_VERSION, + 2, + EGL_CONTEXT_FLAGS_KHR, + EGL_CONTEXT_OPENGL_DEBUG_BIT_KHR, + EGL_NONE, + }; + + egl_context = eglCreateContext(egl_display, config, NULL, context_attrs); + + if (egl_context == EGL_NO_CONTEXT) { + printf("Failed to create OpenGL ES context: %s\n", egl_get_error_str()); + return; + } + + if (!eglMakeCurrent(egl_display, EGL_NO_SURFACE, EGL_NO_SURFACE, egl_context)) + { + printf("Failed to set current OpenGL context: %s\n", egl_get_error_str()); + return; + } + + check_gl(); + + eglExportDMABUFImageMESA = (PFNEGLEXPORTDMABUFIMAGEMESAPROC) + eglGetProcAddress("eglExportDMABUFImageMESA"); + + // Generate textures for the buffers + // GLuint textures[NUM_BUFFERS * 2]; + // glGenTextures(NUM_BUFFERS * 2, textures); + + // for (size_t i = 0; i < NUM_BUFFERS; ++i) { + // input_buffers[i].texture_id = textures[i]; + // input_buffers[i].egl_image = EGL_NO_IMAGE; + // input_buffers[i].dma_fd = -1; + // } + // for (size_t i = 0; i < NUM_BUFFERS; ++i) { + // output_buffers[i].texture_id = textures[NUM_BUFFERS + i]; + // output_buffers[i].egl_image = EGL_NO_IMAGE; + // output_buffers[i].dma_fd = -1; + // } + + check_gl(); + gl_quick_preview_state = gl_quick_preview_new(); + check_gl(); + + printf("Initialized OpenGL\n"); +} + +void +mp_process_pipeline_init_gl(GdkWindow *window) +{ + mp_pipeline_invoke(pipeline, (MPPipelineCallback) init_gl, &window, sizeof(GdkWindow *)); +} + static cairo_surface_t * process_image_for_preview(const uint8_t *image) { - uint32_t surface_width, surface_height, skip; - quick_preview_size(&surface_width, &surface_height, &skip, preview_width, - preview_height, mode.width, mode.height, - mode.pixel_format, camera->rotate); + cairo_surface_t *surface; - cairo_surface_t *surface = cairo_image_surface_create( - CAIRO_FORMAT_RGB24, surface_width, surface_height); + if (gl_quick_preview_state && ql_quick_preview_supports_format(gl_quick_preview_state, mode.pixel_format)) { +#ifdef RENDERDOC + if (rdoc_api) rdoc_api->StartFrameCapture(NULL, NULL); +#endif + glPixelStorei(GL_UNPACK_ALIGNMENT, 1); + check_gl(); - uint8_t *pixels = cairo_image_surface_get_data(surface); + GLuint textures[2]; + glGenTextures(2, textures); - quick_preview((uint32_t *)pixels, surface_width, surface_height, image, - mode.width, mode.height, mode.pixel_format, - camera->rotate, camera->mirrored, - camera->previewmatrix[0] == 0 ? NULL : camera->previewmatrix, - camera->blacklevel, skip); + glBindTexture(GL_TEXTURE_2D, textures[0]); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST); + glTexImage2D(GL_TEXTURE_2D, 0, GL_LUMINANCE, mode.width, mode.height, 0, GL_LUMINANCE, GL_UNSIGNED_BYTE, image); + check_gl(); + + glBindTexture(GL_TEXTURE_2D, textures[1]); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST); + glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST); + glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, preview_width, preview_height, 0, GL_RGBA, GL_UNSIGNED_BYTE, NULL); + check_gl(); + + gl_quick_preview( + gl_quick_preview_state, + textures[1], preview_width, preview_height, + textures[0], mode.width, mode.height, + mode.pixel_format, + camera->rotate, camera->mirrored, + camera->previewmatrix[0] == 0 ? NULL : camera->previewmatrix, + camera->blacklevel); + check_gl(); + + surface = cairo_image_surface_create( + CAIRO_FORMAT_RGB24, preview_width, preview_height); + uint8_t *pixels = cairo_image_surface_get_data(surface); + glReadPixels(0, 0, preview_width, preview_height, GL_RGBA, GL_UNSIGNED_BYTE, pixels); + check_gl(); + + glBindTexture(GL_TEXTURE_2D, 0); + glBindFramebuffer(GL_FRAMEBUFFER, 0); + +#ifdef RENDERDOC + if(rdoc_api) rdoc_api->EndFrameCapture(NULL, NULL); +#endif + } else { + uint32_t surface_width, surface_height, skip; + quick_preview_size(&surface_width, &surface_height, &skip, preview_width, + preview_height, mode.width, mode.height, + mode.pixel_format, camera->rotate); + + surface = cairo_image_surface_create( + CAIRO_FORMAT_RGB24, surface_width, surface_height); + + uint8_t *pixels = cairo_image_surface_get_data(surface); + + quick_preview((uint32_t *)pixels, surface_width, surface_height, image, + mode.width, mode.height, mode.pixel_format, + camera->rotate, camera->mirrored, + camera->previewmatrix[0] == 0 ? NULL : camera->previewmatrix, + camera->blacklevel, skip); + } // Create a thumbnail from the preview for the last capture cairo_surface_t *thumb = NULL; diff --git a/process_pipeline.h b/process_pipeline.h index 351a576..28f1b78 100644 --- a/process_pipeline.h +++ b/process_pipeline.h @@ -2,6 +2,8 @@ #include "camera_config.h" +typedef struct _GdkWindow GdkWindow; + struct mp_process_pipeline_state { const struct mp_camera_config *camera; MPCameraMode mode; @@ -26,6 +28,8 @@ void mp_process_pipeline_start(); void mp_process_pipeline_stop(); void mp_process_pipeline_sync(); +void mp_process_pipeline_init_gl(GdkWindow *window); + void mp_process_pipeline_process_image(MPBuffer buffer); void mp_process_pipeline_capture(); void mp_process_pipeline_update_state(const struct mp_process_pipeline_state *state); diff --git a/renderdoc/app.h b/renderdoc/app.h new file mode 100644 index 0000000..4e1fec2 --- /dev/null +++ b/renderdoc/app.h @@ -0,0 +1,688 @@ +/****************************************************************************** + * The MIT License (MIT) + * + * Copyright (c) 2019-2021 Baldur Karlsson + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + ******************************************************************************/ + +#pragma once + +////////////////////////////////////////////////////////////////////////////////////////////////// +// +// Documentation for the API is available at https://renderdoc.org/docs/in_application_api.html +// + +#if !defined(RENDERDOC_NO_STDINT) +#include +#endif + +#if defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) +#define RENDERDOC_CC __cdecl +#elif defined(__linux__) +#define RENDERDOC_CC +#elif defined(__APPLE__) +#define RENDERDOC_CC +#else +#error "Unknown platform" +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +////////////////////////////////////////////////////////////////////////////////////////////////// +// Constants not used directly in below API + +// This is a GUID/magic value used for when applications pass a path where shader debug +// information can be found to match up with a stripped shader. +// the define can be used like so: const GUID RENDERDOC_ShaderDebugMagicValue = +// RENDERDOC_ShaderDebugMagicValue_value +#define RENDERDOC_ShaderDebugMagicValue_struct \ + { \ + 0xeab25520, 0x6670, 0x4865, 0x84, 0x29, 0x6c, 0x8, 0x51, 0x54, 0x00, 0xff \ + } + +// as an alternative when you want a byte array (assuming x86 endianness): +#define RENDERDOC_ShaderDebugMagicValue_bytearray \ + { \ + 0x20, 0x55, 0xb2, 0xea, 0x70, 0x66, 0x65, 0x48, 0x84, 0x29, 0x6c, 0x8, 0x51, 0x54, 0x00, 0xff \ + } + +// truncated version when only a uint64_t is available (e.g. Vulkan tags): +#define RENDERDOC_ShaderDebugMagicValue_truncated 0x48656670eab25520ULL + +////////////////////////////////////////////////////////////////////////////////////////////////// +// RenderDoc capture options +// + +typedef enum RENDERDOC_CaptureOption { + // Allow the application to enable vsync + // + // Default - enabled + // + // 1 - The application can enable or disable vsync at will + // 0 - vsync is force disabled + eRENDERDOC_Option_AllowVSync = 0, + + // Allow the application to enable fullscreen + // + // Default - enabled + // + // 1 - The application can enable or disable fullscreen at will + // 0 - fullscreen is force disabled + eRENDERDOC_Option_AllowFullscreen = 1, + + // Record API debugging events and messages + // + // Default - disabled + // + // 1 - Enable built-in API debugging features and records the results into + // the capture, which is matched up with events on replay + // 0 - no API debugging is forcibly enabled + eRENDERDOC_Option_APIValidation = 2, + eRENDERDOC_Option_DebugDeviceMode = 2, // deprecated name of this enum + + // Capture CPU callstacks for API events + // + // Default - disabled + // + // 1 - Enables capturing of callstacks + // 0 - no callstacks are captured + eRENDERDOC_Option_CaptureCallstacks = 3, + + // When capturing CPU callstacks, only capture them from drawcalls. + // This option does nothing without the above option being enabled + // + // Default - disabled + // + // 1 - Only captures callstacks for drawcall type API events. + // Ignored if CaptureCallstacks is disabled + // 0 - Callstacks, if enabled, are captured for every event. + eRENDERDOC_Option_CaptureCallstacksOnlyDraws = 4, + + // Specify a delay in seconds to wait for a debugger to attach, after + // creating or injecting into a process, before continuing to allow it to run. + // + // 0 indicates no delay, and the process will run immediately after injection + // + // Default - 0 seconds + // + eRENDERDOC_Option_DelayForDebugger = 5, + + // Verify buffer access. This includes checking the memory returned by a Map() call to + // detect any out-of-bounds modification, as well as initialising buffers with undefined contents + // to a marker value to catch use of uninitialised memory. + // + // NOTE: This option is only valid for OpenGL and D3D11. Explicit APIs such as D3D12 and Vulkan do + // not do the same kind of interception & checking and undefined contents are really undefined. + // + // Default - disabled + // + // 1 - Verify buffer access + // 0 - No verification is performed, and overwriting bounds may cause crashes or corruption in + // RenderDoc. + eRENDERDOC_Option_VerifyBufferAccess = 6, + + // The old name for eRENDERDOC_Option_VerifyBufferAccess was eRENDERDOC_Option_VerifyMapWrites. + // This option now controls the filling of uninitialised buffers with 0xdddddddd which was + // previously always enabled + eRENDERDOC_Option_VerifyMapWrites = eRENDERDOC_Option_VerifyBufferAccess, + + // Hooks any system API calls that create child processes, and injects + // RenderDoc into them recursively with the same options. + // + // Default - disabled + // + // 1 - Hooks into spawned child processes + // 0 - Child processes are not hooked by RenderDoc + eRENDERDOC_Option_HookIntoChildren = 7, + + // By default RenderDoc only includes resources in the final capture necessary + // for that frame, this allows you to override that behaviour. + // + // Default - disabled + // + // 1 - all live resources at the time of capture are included in the capture + // and available for inspection + // 0 - only the resources referenced by the captured frame are included + eRENDERDOC_Option_RefAllResources = 8, + + // **NOTE**: As of RenderDoc v1.1 this option has been deprecated. Setting or + // getting it will be ignored, to allow compatibility with older versions. + // In v1.1 the option acts as if it's always enabled. + // + // By default RenderDoc skips saving initial states for resources where the + // previous contents don't appear to be used, assuming that writes before + // reads indicate previous contents aren't used. + // + // Default - disabled + // + // 1 - initial contents at the start of each captured frame are saved, even if + // they are later overwritten or cleared before being used. + // 0 - unless a read is detected, initial contents will not be saved and will + // appear as black or empty data. + eRENDERDOC_Option_SaveAllInitials = 9, + + // In APIs that allow for the recording of command lists to be replayed later, + // RenderDoc may choose to not capture command lists before a frame capture is + // triggered, to reduce overheads. This means any command lists recorded once + // and replayed many times will not be available and may cause a failure to + // capture. + // + // NOTE: This is only true for APIs where multithreading is difficult or + // discouraged. Newer APIs like Vulkan and D3D12 will ignore this option + // and always capture all command lists since the API is heavily oriented + // around it and the overheads have been reduced by API design. + // + // 1 - All command lists are captured from the start of the application + // 0 - Command lists are only captured if their recording begins during + // the period when a frame capture is in progress. + eRENDERDOC_Option_CaptureAllCmdLists = 10, + + // Mute API debugging output when the API validation mode option is enabled + // + // Default - enabled + // + // 1 - Mute any API debug messages from being displayed or passed through + // 0 - API debugging is displayed as normal + eRENDERDOC_Option_DebugOutputMute = 11, + + // Option to allow vendor extensions to be used even when they may be + // incompatible with RenderDoc and cause corrupted replays or crashes. + // + // Default - inactive + // + // No values are documented, this option should only be used when absolutely + // necessary as directed by a RenderDoc developer. + eRENDERDOC_Option_AllowUnsupportedVendorExtensions = 12, + +} RENDERDOC_CaptureOption; + +// Sets an option that controls how RenderDoc behaves on capture. +// +// Returns 1 if the option and value are valid +// Returns 0 if either is invalid and the option is unchanged +typedef int(RENDERDOC_CC *pRENDERDOC_SetCaptureOptionU32)(RENDERDOC_CaptureOption opt, uint32_t val); +typedef int(RENDERDOC_CC *pRENDERDOC_SetCaptureOptionF32)(RENDERDOC_CaptureOption opt, float val); + +// Gets the current value of an option as a uint32_t +// +// If the option is invalid, 0xffffffff is returned +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetCaptureOptionU32)(RENDERDOC_CaptureOption opt); + +// Gets the current value of an option as a float +// +// If the option is invalid, -FLT_MAX is returned +typedef float(RENDERDOC_CC *pRENDERDOC_GetCaptureOptionF32)(RENDERDOC_CaptureOption opt); + +typedef enum RENDERDOC_InputButton { + // '0' - '9' matches ASCII values + eRENDERDOC_Key_0 = 0x30, + eRENDERDOC_Key_1 = 0x31, + eRENDERDOC_Key_2 = 0x32, + eRENDERDOC_Key_3 = 0x33, + eRENDERDOC_Key_4 = 0x34, + eRENDERDOC_Key_5 = 0x35, + eRENDERDOC_Key_6 = 0x36, + eRENDERDOC_Key_7 = 0x37, + eRENDERDOC_Key_8 = 0x38, + eRENDERDOC_Key_9 = 0x39, + + // 'A' - 'Z' matches ASCII values + eRENDERDOC_Key_A = 0x41, + eRENDERDOC_Key_B = 0x42, + eRENDERDOC_Key_C = 0x43, + eRENDERDOC_Key_D = 0x44, + eRENDERDOC_Key_E = 0x45, + eRENDERDOC_Key_F = 0x46, + eRENDERDOC_Key_G = 0x47, + eRENDERDOC_Key_H = 0x48, + eRENDERDOC_Key_I = 0x49, + eRENDERDOC_Key_J = 0x4A, + eRENDERDOC_Key_K = 0x4B, + eRENDERDOC_Key_L = 0x4C, + eRENDERDOC_Key_M = 0x4D, + eRENDERDOC_Key_N = 0x4E, + eRENDERDOC_Key_O = 0x4F, + eRENDERDOC_Key_P = 0x50, + eRENDERDOC_Key_Q = 0x51, + eRENDERDOC_Key_R = 0x52, + eRENDERDOC_Key_S = 0x53, + eRENDERDOC_Key_T = 0x54, + eRENDERDOC_Key_U = 0x55, + eRENDERDOC_Key_V = 0x56, + eRENDERDOC_Key_W = 0x57, + eRENDERDOC_Key_X = 0x58, + eRENDERDOC_Key_Y = 0x59, + eRENDERDOC_Key_Z = 0x5A, + + // leave the rest of the ASCII range free + // in case we want to use it later + eRENDERDOC_Key_NonPrintable = 0x100, + + eRENDERDOC_Key_Divide, + eRENDERDOC_Key_Multiply, + eRENDERDOC_Key_Subtract, + eRENDERDOC_Key_Plus, + + eRENDERDOC_Key_F1, + eRENDERDOC_Key_F2, + eRENDERDOC_Key_F3, + eRENDERDOC_Key_F4, + eRENDERDOC_Key_F5, + eRENDERDOC_Key_F6, + eRENDERDOC_Key_F7, + eRENDERDOC_Key_F8, + eRENDERDOC_Key_F9, + eRENDERDOC_Key_F10, + eRENDERDOC_Key_F11, + eRENDERDOC_Key_F12, + + eRENDERDOC_Key_Home, + eRENDERDOC_Key_End, + eRENDERDOC_Key_Insert, + eRENDERDOC_Key_Delete, + eRENDERDOC_Key_PageUp, + eRENDERDOC_Key_PageDn, + + eRENDERDOC_Key_Backspace, + eRENDERDOC_Key_Tab, + eRENDERDOC_Key_PrtScrn, + eRENDERDOC_Key_Pause, + + eRENDERDOC_Key_Max, +} RENDERDOC_InputButton; + +// Sets which key or keys can be used to toggle focus between multiple windows +// +// If keys is NULL or num is 0, toggle keys will be disabled +typedef void(RENDERDOC_CC *pRENDERDOC_SetFocusToggleKeys)(RENDERDOC_InputButton *keys, int num); + +// Sets which key or keys can be used to capture the next frame +// +// If keys is NULL or num is 0, captures keys will be disabled +typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureKeys)(RENDERDOC_InputButton *keys, int num); + +typedef enum RENDERDOC_OverlayBits { + // This single bit controls whether the overlay is enabled or disabled globally + eRENDERDOC_Overlay_Enabled = 0x1, + + // Show the average framerate over several seconds as well as min/max + eRENDERDOC_Overlay_FrameRate = 0x2, + + // Show the current frame number + eRENDERDOC_Overlay_FrameNumber = 0x4, + + // Show a list of recent captures, and how many captures have been made + eRENDERDOC_Overlay_CaptureList = 0x8, + + // Default values for the overlay mask + eRENDERDOC_Overlay_Default = (eRENDERDOC_Overlay_Enabled | eRENDERDOC_Overlay_FrameRate | + eRENDERDOC_Overlay_FrameNumber | eRENDERDOC_Overlay_CaptureList), + + // Enable all bits + eRENDERDOC_Overlay_All = ~0U, + + // Disable all bits + eRENDERDOC_Overlay_None = 0, +} RENDERDOC_OverlayBits; + +// returns the overlay bits that have been set +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetOverlayBits)(); +// sets the overlay bits with an and & or mask +typedef void(RENDERDOC_CC *pRENDERDOC_MaskOverlayBits)(uint32_t And, uint32_t Or); + +// this function will attempt to remove RenderDoc's hooks in the application. +// +// Note: that this can only work correctly if done immediately after +// the module is loaded, before any API work happens. RenderDoc will remove its +// injected hooks and shut down. Behaviour is undefined if this is called +// after any API functions have been called, and there is still no guarantee of +// success. +typedef void(RENDERDOC_CC *pRENDERDOC_RemoveHooks)(); + +// DEPRECATED: compatibility for code compiled against pre-1.4.1 headers. +typedef pRENDERDOC_RemoveHooks pRENDERDOC_Shutdown; + +// This function will unload RenderDoc's crash handler. +// +// If you use your own crash handler and don't want RenderDoc's handler to +// intercede, you can call this function to unload it and any unhandled +// exceptions will pass to the next handler. +typedef void(RENDERDOC_CC *pRENDERDOC_UnloadCrashHandler)(); + +// Sets the capture file path template +// +// pathtemplate is a UTF-8 string that gives a template for how captures will be named +// and where they will be saved. +// +// Any extension is stripped off the path, and captures are saved in the directory +// specified, and named with the filename and the frame number appended. If the +// directory does not exist it will be created, including any parent directories. +// +// If pathtemplate is NULL, the template will remain unchanged +// +// Example: +// +// SetCaptureFilePathTemplate("my_captures/example"); +// +// Capture #1 -> my_captures/example_frame123.rdc +// Capture #2 -> my_captures/example_frame456.rdc +typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureFilePathTemplate)(const char *pathtemplate); + +// returns the current capture path template, see SetCaptureFileTemplate above, as a UTF-8 string +typedef const char *(RENDERDOC_CC *pRENDERDOC_GetCaptureFilePathTemplate)(); + +// DEPRECATED: compatibility for code compiled against pre-1.1.2 headers. +typedef pRENDERDOC_SetCaptureFilePathTemplate pRENDERDOC_SetLogFilePathTemplate; +typedef pRENDERDOC_GetCaptureFilePathTemplate pRENDERDOC_GetLogFilePathTemplate; + +// returns the number of captures that have been made +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetNumCaptures)(); + +// This function returns the details of a capture, by index. New captures are added +// to the end of the list. +// +// filename will be filled with the absolute path to the capture file, as a UTF-8 string +// pathlength will be written with the length in bytes of the filename string +// timestamp will be written with the time of the capture, in seconds since the Unix epoch +// +// Any of the parameters can be NULL and they'll be skipped. +// +// The function will return 1 if the capture index is valid, or 0 if the index is invalid +// If the index is invalid, the values will be unchanged +// +// Note: when captures are deleted in the UI they will remain in this list, so the +// capture path may not exist anymore. +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_GetCapture)(uint32_t idx, char *filename, + uint32_t *pathlength, uint64_t *timestamp); + +// Sets the comments associated with a capture file. These comments are displayed in the +// UI program when opening. +// +// filePath should be a path to the capture file to add comments to. If set to NULL or "" +// the most recent capture file created made will be used instead. +// comments should be a NULL-terminated UTF-8 string to add as comments. +// +// Any existing comments will be overwritten. +typedef void(RENDERDOC_CC *pRENDERDOC_SetCaptureFileComments)(const char *filePath, + const char *comments); + +// returns 1 if the RenderDoc UI is connected to this application, 0 otherwise +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_IsTargetControlConnected)(); + +// DEPRECATED: compatibility for code compiled against pre-1.1.1 headers. +// This was renamed to IsTargetControlConnected in API 1.1.1, the old typedef is kept here for +// backwards compatibility with old code, it is castable either way since it's ABI compatible +// as the same function pointer type. +typedef pRENDERDOC_IsTargetControlConnected pRENDERDOC_IsRemoteAccessConnected; + +// This function will launch the Replay UI associated with the RenderDoc library injected +// into the running application. +// +// if connectTargetControl is 1, the Replay UI will be launched with a command line parameter +// to connect to this application +// cmdline is the rest of the command line, as a UTF-8 string. E.g. a captures to open +// if cmdline is NULL, the command line will be empty. +// +// returns the PID of the replay UI if successful, 0 if not successful. +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_LaunchReplayUI)(uint32_t connectTargetControl, + const char *cmdline); + +// RenderDoc can return a higher version than requested if it's backwards compatible, +// this function returns the actual version returned. If a parameter is NULL, it will be +// ignored and the others will be filled out. +typedef void(RENDERDOC_CC *pRENDERDOC_GetAPIVersion)(int *major, int *minor, int *patch); + +////////////////////////////////////////////////////////////////////////// +// Capturing functions +// + +// A device pointer is a pointer to the API's root handle. +// +// This would be an ID3D11Device, HGLRC/GLXContext, ID3D12Device, etc +typedef void *RENDERDOC_DevicePointer; + +// A window handle is the OS's native window handle +// +// This would be an HWND, GLXDrawable, etc +typedef void *RENDERDOC_WindowHandle; + +// A helper macro for Vulkan, where the device handle cannot be used directly. +// +// Passing the VkInstance to this macro will return the RENDERDOC_DevicePointer to use. +// +// Specifically, the value needed is the dispatch table pointer, which sits as the first +// pointer-sized object in the memory pointed to by the VkInstance. Thus we cast to a void** and +// indirect once. +#define RENDERDOC_DEVICEPOINTER_FROM_VKINSTANCE(inst) (*((void **)(inst))) + +// This sets the RenderDoc in-app overlay in the API/window pair as 'active' and it will +// respond to keypresses. Neither parameter can be NULL +typedef void(RENDERDOC_CC *pRENDERDOC_SetActiveWindow)(RENDERDOC_DevicePointer device, + RENDERDOC_WindowHandle wndHandle); + +// capture the next frame on whichever window and API is currently considered active +typedef void(RENDERDOC_CC *pRENDERDOC_TriggerCapture)(); + +// capture the next N frames on whichever window and API is currently considered active +typedef void(RENDERDOC_CC *pRENDERDOC_TriggerMultiFrameCapture)(uint32_t numFrames); + +// When choosing either a device pointer or a window handle to capture, you can pass NULL. +// Passing NULL specifies a 'wildcard' match against anything. This allows you to specify +// any API rendering to a specific window, or a specific API instance rendering to any window, +// or in the simplest case of one window and one API, you can just pass NULL for both. +// +// In either case, if there are two or more possible matching (device,window) pairs it +// is undefined which one will be captured. +// +// Note: for headless rendering you can pass NULL for the window handle and either specify +// a device pointer or leave it NULL as above. + +// Immediately starts capturing API calls on the specified device pointer and window handle. +// +// If there is no matching thing to capture (e.g. no supported API has been initialised), +// this will do nothing. +// +// The results are undefined (including crashes) if two captures are started overlapping, +// even on separate devices and/oror windows. +typedef void(RENDERDOC_CC *pRENDERDOC_StartFrameCapture)(RENDERDOC_DevicePointer device, + RENDERDOC_WindowHandle wndHandle); + +// Returns whether or not a frame capture is currently ongoing anywhere. +// +// This will return 1 if a capture is ongoing, and 0 if there is no capture running +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_IsFrameCapturing)(); + +// Ends capturing immediately. +// +// This will return 1 if the capture succeeded, and 0 if there was an error capturing. +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_EndFrameCapture)(RENDERDOC_DevicePointer device, + RENDERDOC_WindowHandle wndHandle); + +// Ends capturing immediately and discard any data stored without saving to disk. +// +// This will return 1 if the capture was discarded, and 0 if there was an error or no capture +// was in progress +typedef uint32_t(RENDERDOC_CC *pRENDERDOC_DiscardFrameCapture)(RENDERDOC_DevicePointer device, + RENDERDOC_WindowHandle wndHandle); + +////////////////////////////////////////////////////////////////////////////////////////////////// +// RenderDoc API versions +// + +// RenderDoc uses semantic versioning (http://semver.org/). +// +// MAJOR version is incremented when incompatible API changes happen. +// MINOR version is incremented when functionality is added in a backwards-compatible manner. +// PATCH version is incremented when backwards-compatible bug fixes happen. +// +// Note that this means the API returned can be higher than the one you might have requested. +// e.g. if you are running against a newer RenderDoc that supports 1.0.1, it will be returned +// instead of 1.0.0. You can check this with the GetAPIVersion entry point +typedef enum RENDERDOC_Version { + eRENDERDOC_API_Version_1_0_0 = 10000, // RENDERDOC_API_1_0_0 = 1 00 00 + eRENDERDOC_API_Version_1_0_1 = 10001, // RENDERDOC_API_1_0_1 = 1 00 01 + eRENDERDOC_API_Version_1_0_2 = 10002, // RENDERDOC_API_1_0_2 = 1 00 02 + eRENDERDOC_API_Version_1_1_0 = 10100, // RENDERDOC_API_1_1_0 = 1 01 00 + eRENDERDOC_API_Version_1_1_1 = 10101, // RENDERDOC_API_1_1_1 = 1 01 01 + eRENDERDOC_API_Version_1_1_2 = 10102, // RENDERDOC_API_1_1_2 = 1 01 02 + eRENDERDOC_API_Version_1_2_0 = 10200, // RENDERDOC_API_1_2_0 = 1 02 00 + eRENDERDOC_API_Version_1_3_0 = 10300, // RENDERDOC_API_1_3_0 = 1 03 00 + eRENDERDOC_API_Version_1_4_0 = 10400, // RENDERDOC_API_1_4_0 = 1 04 00 + eRENDERDOC_API_Version_1_4_1 = 10401, // RENDERDOC_API_1_4_1 = 1 04 01 +} RENDERDOC_Version; + +// API version changelog: +// +// 1.0.0 - initial release +// 1.0.1 - Bugfix: IsFrameCapturing() was returning false for captures that were triggered +// by keypress or TriggerCapture, instead of Start/EndFrameCapture. +// 1.0.2 - Refactor: Renamed eRENDERDOC_Option_DebugDeviceMode to eRENDERDOC_Option_APIValidation +// 1.1.0 - Add feature: TriggerMultiFrameCapture(). Backwards compatible with 1.0.x since the new +// function pointer is added to the end of the struct, the original layout is identical +// 1.1.1 - Refactor: Renamed remote access to target control (to better disambiguate from remote +// replay/remote server concept in replay UI) +// 1.1.2 - Refactor: Renamed "log file" in function names to just capture, to clarify that these +// are captures and not debug logging files. This is the first API version in the v1.0 +// branch. +// 1.2.0 - Added feature: SetCaptureFileComments() to add comments to a capture file that will be +// displayed in the UI program on load. +// 1.3.0 - Added feature: New capture option eRENDERDOC_Option_AllowUnsupportedVendorExtensions +// which allows users to opt-in to allowing unsupported vendor extensions to function. +// Should be used at the user's own risk. +// Refactor: Renamed eRENDERDOC_Option_VerifyMapWrites to +// eRENDERDOC_Option_VerifyBufferAccess, which now also controls initialisation to +// 0xdddddddd of uninitialised buffer contents. +// 1.4.0 - Added feature: DiscardFrameCapture() to discard a frame capture in progress and stop +// capturing without saving anything to disk. +// 1.4.1 - Refactor: Renamed Shutdown to RemoveHooks to better clarify what is happening + +typedef struct RENDERDOC_API_1_4_1 +{ + pRENDERDOC_GetAPIVersion GetAPIVersion; + + pRENDERDOC_SetCaptureOptionU32 SetCaptureOptionU32; + pRENDERDOC_SetCaptureOptionF32 SetCaptureOptionF32; + + pRENDERDOC_GetCaptureOptionU32 GetCaptureOptionU32; + pRENDERDOC_GetCaptureOptionF32 GetCaptureOptionF32; + + pRENDERDOC_SetFocusToggleKeys SetFocusToggleKeys; + pRENDERDOC_SetCaptureKeys SetCaptureKeys; + + pRENDERDOC_GetOverlayBits GetOverlayBits; + pRENDERDOC_MaskOverlayBits MaskOverlayBits; + + // Shutdown was renamed to RemoveHooks in 1.4.1. + // These unions allow old code to continue compiling without changes + union + { + pRENDERDOC_Shutdown Shutdown; + pRENDERDOC_RemoveHooks RemoveHooks; + }; + pRENDERDOC_UnloadCrashHandler UnloadCrashHandler; + + // Get/SetLogFilePathTemplate was renamed to Get/SetCaptureFilePathTemplate in 1.1.2. + // These unions allow old code to continue compiling without changes + union + { + // deprecated name + pRENDERDOC_SetLogFilePathTemplate SetLogFilePathTemplate; + // current name + pRENDERDOC_SetCaptureFilePathTemplate SetCaptureFilePathTemplate; + }; + union + { + // deprecated name + pRENDERDOC_GetLogFilePathTemplate GetLogFilePathTemplate; + // current name + pRENDERDOC_GetCaptureFilePathTemplate GetCaptureFilePathTemplate; + }; + + pRENDERDOC_GetNumCaptures GetNumCaptures; + pRENDERDOC_GetCapture GetCapture; + + pRENDERDOC_TriggerCapture TriggerCapture; + + // IsRemoteAccessConnected was renamed to IsTargetControlConnected in 1.1.1. + // This union allows old code to continue compiling without changes + union + { + // deprecated name + pRENDERDOC_IsRemoteAccessConnected IsRemoteAccessConnected; + // current name + pRENDERDOC_IsTargetControlConnected IsTargetControlConnected; + }; + pRENDERDOC_LaunchReplayUI LaunchReplayUI; + + pRENDERDOC_SetActiveWindow SetActiveWindow; + + pRENDERDOC_StartFrameCapture StartFrameCapture; + pRENDERDOC_IsFrameCapturing IsFrameCapturing; + pRENDERDOC_EndFrameCapture EndFrameCapture; + + // new function in 1.1.0 + pRENDERDOC_TriggerMultiFrameCapture TriggerMultiFrameCapture; + + // new function in 1.2.0 + pRENDERDOC_SetCaptureFileComments SetCaptureFileComments; + + // new function in 1.4.0 + pRENDERDOC_DiscardFrameCapture DiscardFrameCapture; +} RENDERDOC_API_1_4_1; + +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_0_0; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_0_1; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_0_2; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_1_0; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_1_1; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_1_2; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_2_0; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_3_0; +typedef RENDERDOC_API_1_4_1 RENDERDOC_API_1_4_0; + +////////////////////////////////////////////////////////////////////////////////////////////////// +// RenderDoc API entry point +// +// This entry point can be obtained via GetProcAddress/dlsym if RenderDoc is available. +// +// The name is the same as the typedef - "RENDERDOC_GetAPI" +// +// This function is not thread safe, and should not be called on multiple threads at once. +// Ideally, call this once as early as possible in your application's startup, before doing +// any API work, since some configuration functionality etc has to be done also before +// initialising any APIs. +// +// Parameters: +// version is a single value from the RENDERDOC_Version above. +// +// outAPIPointers will be filled out with a pointer to the corresponding struct of function +// pointers. +// +// Returns: +// 1 - if the outAPIPointers has been filled with a pointer to the API struct requested +// 0 - if the requested version is not supported or the arguments are invalid. +// +typedef int(RENDERDOC_CC *pRENDERDOC_GetAPI)(RENDERDOC_Version version, void **outAPIPointers); + +#ifdef __cplusplus +} // extern "C" +#endif