wut  v1.7.0
Wii U Toolchain
debug.h
Go to the documentation of this file.
1 #pragma once
2 #include <wut.h>
3 #include "surface.h"
4 
11 #ifdef __cplusplus
12 extern "C" {
13 #endif
14 
15 typedef struct GX2DebugCaptureInterface GX2DebugCaptureInterface;
16 
17 typedef enum GX2DebugCaptureInterfaceVersion
18 {
19  GX2_DEBUG_CAPTURE_INTERFACE_VERSION = 1,
20 } GX2DebugCaptureInterfaceVersion;
21 
23 typedef enum GX2DebugCaptureStartFlags
24 {
26  GX2_DEBUG_CAPTURE_START_FLAGS_NONE = 0,
27 
29  GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE = 1,
30 } GX2DebugCaptureStartFlags;
31 
33 typedef enum GX2DebugCaptureEndFlags
34 {
36  GX2_DEBUG_CAPTURE_END_FLAGS_NONE = 0,
37 
39  GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH = 1,
40 } GX2DebugCaptureEndFlags;
41 
42 struct GX2DebugCaptureInterface
43 {
45  uint32_t version;
46 
48  void (*onShutdown)();
49 
51  void (*setAllocator)();
52 
55  void (*onCaptureStart)(const char *filename);
56 
58  void (*onCaptureEnd)();
59 
61  BOOL (*isCaptureEnabled)();
62 
64  void (*onAlloc)(void *ptr, uint32_t size, uint32_t align);
65 
67  void (*onFree)(void *ptr);
68 
70  void (*onUnknownMemory)(void *ptr, uint32_t size);
71 
73  void (*setOutputSurface)(GX2Surface *surface);
74 
76  void (*onSwapScanBuffers)(GX2Surface *surface);
77 
81  void (*submitToRing)(void *unk1,
82  uint32_t unk2,
83  uint32_t *unk3,
84  uint64_t *outSubmitTimestamp);
85 };
86 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x00, version);
87 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x04, onShutdown);
88 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x08, setAllocator);
89 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x0C, onCaptureStart);
90 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x10, onCaptureEnd);
91 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x14, isCaptureEnabled);
92 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x18, onAlloc);
93 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x1C, onFree);
94 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x20, onUnknownMemory);
95 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x24, setOutputSurface);
96 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x28, onSwapScanBuffers);
97 WUT_CHECK_OFFSET(GX2DebugCaptureInterface, 0x2C, submitToRing);
98 WUT_CHECK_SIZE(GX2DebugCaptureInterface, 0x30);
99 
100 BOOL
101 _GX2DebugSetCaptureInterface(GX2DebugCaptureInterface *interface);
102 
103 
119 void
120 GX2DebugCaptureStart(const char *filename,
121  GX2DebugCaptureStartFlags flags);
122 
123 
130 void
131 GX2DebugCaptureEnd(GX2DebugCaptureEndFlags flags);
132 
133 
142 void
143 GX2DebugCaptureFrame(const char* filename);
144 
145 
154 void
155 GX2DebugCaptureFrames(const char* filename,
156  uint32_t count);
157 
158 #ifdef __cplusplus
159 }
160 #endif
161 
GX2DebugCaptureInterfaceVersion
GX2DebugCaptureInterfaceVersion
Definition: debug.h:18
GX2DebugCaptureStart
void GX2DebugCaptureStart(const char *filename, GX2DebugCaptureStartFlags flags)
Starts a debug capture.
_GX2DebugSetCaptureInterface
BOOL _GX2DebugSetCaptureInterface(GX2DebugCaptureInterface *interface)
GX2DebugCaptureStartFlags
GX2DebugCaptureStartFlags
Options for GX2DebugCaptureStart.
Definition: debug.h:24
GX2DebugCaptureEnd
void GX2DebugCaptureEnd(GX2DebugCaptureEndFlags flags)
Ends a debug capture.
GX2DebugCaptureFrames
void GX2DebugCaptureFrames(const char *filename, uint32_t count)
Will capture count frames.
GX2DebugCaptureEndFlags
GX2DebugCaptureEndFlags
Options for GX2DebugCaptureEnd.
Definition: debug.h:34
GX2DebugCaptureFrame
void GX2DebugCaptureFrame(const char *filename)
Will capture the next frame.
GX2_DEBUG_CAPTURE_INTERFACE_VERSION
@ GX2_DEBUG_CAPTURE_INTERFACE_VERSION
Definition: debug.h:19
GX2_DEBUG_CAPTURE_START_FLAGS_NONE
@ GX2_DEBUG_CAPTURE_START_FLAGS_NONE
When set GX2DebugCaptureStart will call GX2DrawDone before the capture is started.
Definition: debug.h:26
GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE
@ GX2_DEBUG_CAPTURE_START_FLAGS_DISABLE_GX2DRAWDONE
When set GX2DebugCaptureStart will NOT call GX2DrawDone.
Definition: debug.h:29
GX2_DEBUG_CAPTURE_END_FLAGS_NONE
@ GX2_DEBUG_CAPTURE_END_FLAGS_NONE
When set GX2DebugCaptureEnd will call GX2Flush before the capture is completed.
Definition: debug.h:36
GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH
@ GX2_DEBUG_CAPTURE_END_FLAGS_DISABLE_GX2FLUSH
When set GX2DebugCaptureEnd will NOT call GX2Flush.
Definition: debug.h:39
GX2Surface
Definition: surface.h:23
GX2DebugCaptureInterface::isCaptureEnabled
BOOL(* isCaptureEnabled)()
Check if capture is enabled.
Definition: debug.h:61
GX2DebugCaptureInterface::onCaptureEnd
void(* onCaptureEnd)()
Called from GX2DebugCaptureEnd.
Definition: debug.h:58
GX2DebugCaptureInterface::onFree
void(* onFree)(void *ptr)
Called when GX2 memory is freed.
Definition: debug.h:67
GX2DebugCaptureInterface::onCaptureStart
void(* onCaptureStart)(const char *filename)
Called from GX2DebugCaptureStart, the filename is first argument passed in to GX2DebugCaptureStart.
Definition: debug.h:55
GX2DebugCaptureInterface::onAlloc
void(* onAlloc)(void *ptr, uint32_t size, uint32_t align)
Called when GX2 memory is allocated.
Definition: debug.h:64
GX2DebugCaptureInterface::onUnknownMemory
void(* onUnknownMemory)(void *ptr, uint32_t size)
UNKNOWN: Called when something happens with some memory.
Definition: debug.h:70
GX2DebugCaptureInterface::setOutputSurface
void(* setOutputSurface)(GX2Surface *surface)
Called from GX2DebugCaptureStart with the TV scan buffer.
Definition: debug.h:73
GX2DebugCaptureInterface::setAllocator
void(* setAllocator)()
Called from GX2DebugSetCaptureInterface with the default gx2 allocators.
Definition: debug.h:51
GX2DebugCaptureInterface::version
uint32_t version
Must be set to GX2_DEBUG_CAPTURE_INTERFACE_VERSION.
Definition: debug.h:45
GX2DebugCaptureInterface::submitToRing
void(* submitToRing)(void *unk1, uint32_t unk2, uint32_t *unk3, uint64_t *outSubmitTimestamp)
Called when a command buffer is ready to be submitted to ring buffer.
Definition: debug.h:81
GX2DebugCaptureInterface::onSwapScanBuffers
void(* onSwapScanBuffers)(GX2Surface *surface)
Called from GX2SwapScanBuffers with the TV scan buffer.
Definition: debug.h:76
GX2DebugCaptureInterface::onShutdown
void(* onShutdown)()
Called from GX2Shutdown.
Definition: debug.h:48
BOOL
int32_t BOOL
Definition: wut_types.h:7
Generated by doxygen 1.9.1