SDL/src/video/SDL_sysvideo.h at SDL2 · mstan/SDL

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

Simple DirectMedia Layer

This software is provided 'as-is', without any express or implied

warranty. In no event will the authors be held liable for any damages

arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,

including commercial applications, and to alter it and redistribute it

freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not

claim that you wrote the original software. If you use this software

in a product, an acknowledgment in the product documentation would be

appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be

misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.

#include "../SDL_internal.h"

#ifndef SDL_sysvideo_h_

#define SDL_sysvideo_h_

#include "SDL_messagebox.h"

#include "SDL_mouse.h"

#include "SDL_shape.h"

#include "SDL_thread.h"

#include "SDL_metal.h"

#include "SDL_vulkan_internal.h"

/* The SDL video driver */

typedef struct SDL_WindowShaper SDL_WindowShaper;

typedef struct SDL_ShapeDriver SDL_ShapeDriver;

typedef struct SDL_VideoDisplay SDL_VideoDisplay;

typedef struct SDL_VideoDevice SDL_VideoDevice;

/* Define the SDL window-shaper structure */

struct SDL_WindowShaper

{

/* The window associated with the shaper */

SDL_Window *window;

/* The user's specified coordinates for the window, for once we give it a shape. */

Uint32 userx, usery;

/* The parameters for shape calculation. */

SDL_WindowShapeMode mode;

/* Has this window been assigned a shape? */

SDL_bool hasshape;

void *driverdata;

};

/* Define the SDL shape driver structure */

struct SDL_ShapeDriver

{

SDL_WindowShaper *(*CreateShaper)(SDL_Window *window);

int (*SetWindowShape)(SDL_WindowShaper *shaper, SDL_Surface *shape, SDL_WindowShapeMode *shape_mode);

int (*ResizeWindowShape)(SDL_Window *window);

};

typedef struct SDL_WindowUserData

{

char *name;

void *data;

struct SDL_WindowUserData *next;

} SDL_WindowUserData;

/* Define the SDL window structure, corresponding to toplevel windows */

struct SDL_Window

{

const void *magic;

Uint32 id;

char *title;

SDL_Surface *icon;

int x, y;

int w, h;

int min_w, min_h;

int max_w, max_h;

Uint32 flags;

Uint32 last_fullscreen_flags;

Uint32 display_index;

/* Stored position and size for windowed mode */

SDL_Rect windowed;

SDL_DisplayMode fullscreen_mode;

float opacity;

float brightness;

Uint16 *gamma;

Uint16 *saved_gamma; /* (just offset into gamma) */

SDL_Surface *surface;

SDL_bool surface_valid;

SDL_bool is_hiding;

SDL_bool is_destroying;

SDL_bool is_dropping; /* drag/drop in progress, expecting SDL_SendDropComplete(). */

SDL_Rect mouse_rect;

SDL_WindowShaper *shaper;

SDL_HitTest hit_test;

void *hit_test_data;

SDL_WindowUserData *data;

void *driverdata;

SDL_Window *prev;

SDL_Window *next;

};

#define FULLSCREEN_VISIBLE(W) \

(((W)->flags & SDL_WINDOW_FULLSCREEN) && \

((W)->flags & SDL_WINDOW_SHOWN) && \

!((W)->flags & SDL_WINDOW_MINIMIZED))

* Define the SDL display structure.

* This corresponds to physical monitors attached to the system.

struct SDL_VideoDisplay

{

char *name;

int max_display_modes;

int num_display_modes;

SDL_DisplayMode *display_modes;

SDL_DisplayMode desktop_mode;

SDL_DisplayMode current_mode;

SDL_DisplayOrientation orientation;

SDL_Window *fullscreen_window;

SDL_VideoDevice *device;

void *driverdata;

};

/* Forward declaration */

struct SDL_SysWMinfo;

/* Define the SDL video driver structure */

#define _THIS SDL_VideoDevice *_this

/* Video device flags */

typedef enum

{

VIDEO_DEVICE_QUIRK_DISABLE_DISPLAY_MODE_SWITCHING = 0x01,

VIDEO_DEVICE_QUIRK_DISABLE_UNSET_FULLSCREEN_ON_MINIMIZE = 0x02,

VIDEO_DEVICE_QUIRK_FULLSCREEN_ONLY = 0x04,

} DeviceQuirkFlags;

struct SDL_VideoDevice

{

/* * * */

/* The name of this video driver */

const char *name;

/* * * */

/* Initialization/Query functions */

* Initialize the native video subsystem, filling in the list of

* displays for this driver, returning 0 or -1 if there's an error.

int (*VideoInit)(_THIS);

* Reverse the effects VideoInit() -- called if VideoInit() fails or

* if the application is shutting down the video subsystem.

void (*VideoQuit)(_THIS);

* Reinitialize the touch devices -- called if an unknown touch ID occurs.

void (*ResetTouch)(_THIS);

/* * * */

* Display functions

* Refresh the display list

void (*RefreshDisplays)(_THIS);

* Get the bounds of a display

int (*GetDisplayBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect);

* Get the usable bounds of a display (bounds minus menubar or whatever)

int (*GetDisplayUsableBounds)(_THIS, SDL_VideoDisplay *display, SDL_Rect *rect);

* Get the dots/pixels-per-inch of a display

int (*GetDisplayDPI)(_THIS, SDL_VideoDisplay *display, float *ddpi, float *hdpi, float *vdpi);

* Get a list of the available display modes for a display.

void (*GetDisplayModes)(_THIS, SDL_VideoDisplay *display);

* Setting the display mode is independent of creating windows, so

* when the display mode is changed, all existing windows should have

* their data updated accordingly, including the display surfaces

* associated with them.

int (*SetDisplayMode)(_THIS, SDL_VideoDisplay *display, SDL_DisplayMode *mode);

/* * * */

* Window functions

int (*CreateSDLWindow)(_THIS, SDL_Window *window);

int (*CreateSDLWindowFrom)(_THIS, SDL_Window *window, const void *data);

void (*SetWindowTitle)(_THIS, SDL_Window *window);

void (*SetWindowIcon)(_THIS, SDL_Window *window, SDL_Surface *icon);

void (*SetWindowPosition)(_THIS, SDL_Window *window);

void (*SetWindowSize)(_THIS, SDL_Window *window);

void (*SetWindowMinimumSize)(_THIS, SDL_Window *window);

void (*SetWindowMaximumSize)(_THIS, SDL_Window *window);

int (*GetWindowBordersSize)(_THIS, SDL_Window *window, int *top, int *left, int *bottom, int *right);

void (*GetWindowSizeInPixels)(_THIS, SDL_Window *window, int *w, int *h);

int (*SetWindowOpacity) (_THIS, SDL_Window * window, float opacity);

int (*SetWindowModalFor) (_THIS, SDL_Window * modal_window, SDL_Window * parent_window);

int (*SetWindowInputFocus) (_THIS, SDL_Window * window);

void (*ShowWindow) (_THIS, SDL_Window * window);

void (*HideWindow) (_THIS, SDL_Window * window);

void (*RaiseWindow) (_THIS, SDL_Window * window);

void (*MaximizeWindow) (_THIS, SDL_Window * window);

void (*MinimizeWindow) (_THIS, SDL_Window * window);

void (*RestoreWindow) (_THIS, SDL_Window * window);

void (*SetWindowBordered) (_THIS, SDL_Window * window, SDL_bool bordered);

void (*SetWindowResizable) (_THIS, SDL_Window * window, SDL_bool resizable);

void (*SetWindowAlwaysOnTop) (_THIS, SDL_Window * window, SDL_bool on_top);

void (*SetWindowFullscreen) (_THIS, SDL_Window * window, SDL_VideoDisplay * display, SDL_bool fullscreen);

int (*SetWindowGammaRamp) (_THIS, SDL_Window * window, const Uint16 * ramp);

int (*GetWindowGammaRamp) (_THIS, SDL_Window * window, Uint16 * ramp);

void* (*GetWindowICCProfile) (_THIS, SDL_Window * window, size_t* size);

int (*GetWindowDisplayIndex)(_THIS, SDL_Window * window);

void (*SetWindowMouseRect)(_THIS, SDL_Window * window);

void (*SetWindowMouseGrab) (_THIS, SDL_Window * window, SDL_bool grabbed);

void (*SetWindowKeyboardGrab) (_THIS, SDL_Window * window, SDL_bool grabbed);

void (*DestroyWindow) (_THIS, SDL_Window * window);

int (*CreateWindowFramebuffer) (_THIS, SDL_Window * window, Uint32 * format, void ** pixels, int *pitch);

int (*UpdateWindowFramebuffer) (_THIS, SDL_Window * window, const SDL_Rect * rects, int numrects);

void (*DestroyWindowFramebuffer) (_THIS, SDL_Window * window);

void (*OnWindowEnter) (_THIS, SDL_Window * window);

int (*FlashWindow) (_THIS, SDL_Window * window, SDL_FlashOperation operation);

/* * * */

* Shaped-window functions

SDL_ShapeDriver shape_driver;

/* Get some platform dependent window information */

SDL_bool(*GetWindowWMInfo) (_THIS, SDL_Window * window,

struct SDL_SysWMinfo * info);

/* * * */

* OpenGL support

int (*GL_LoadLibrary) (_THIS, const char *path);

void *(*GL_GetProcAddress) (_THIS, const char *proc);

void (*GL_UnloadLibrary) (_THIS);

SDL_GLContext(*GL_CreateContext) (_THIS, SDL_Window * window);

int (*GL_MakeCurrent) (_THIS, SDL_Window * window, SDL_GLContext context);

void (*GL_GetDrawableSize) (_THIS, SDL_Window * window, int *w, int *h);

int (*GL_SetSwapInterval) (_THIS, int interval);

int (*GL_GetSwapInterval) (_THIS);

int (*GL_SwapWindow) (_THIS, SDL_Window * window);

void (*GL_DeleteContext) (_THIS, SDL_GLContext context);

void (*GL_DefaultProfileConfig) (_THIS, int *mask, int *major, int *minor);

/* * * */

* Vulkan support

int (*Vulkan_LoadLibrary)(_THIS, const char *path);

void (*Vulkan_UnloadLibrary)(_THIS);

SDL_bool (*Vulkan_GetInstanceExtensions)(_THIS, SDL_Window *window, unsigned *count, const char **names);

SDL_bool (*Vulkan_CreateSurface)(_THIS, SDL_Window *window, VkInstance instance, VkSurfaceKHR *surface);

void (*Vulkan_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h);

/* * * */

* Metal support

SDL_MetalView (*Metal_CreateView)(_THIS, SDL_Window *window);

void (*Metal_DestroyView)(_THIS, SDL_MetalView view);

void *(*Metal_GetLayer)(_THIS, SDL_MetalView view);

void (*Metal_GetDrawableSize)(_THIS, SDL_Window *window, int *w, int *h);

/* * * */

* Event manager functions

int (*WaitEventTimeout)(_THIS, int timeout);

void (*SendWakeupEvent)(_THIS, SDL_Window *window);

void (*PumpEvents)(_THIS);

/* Suspend the screensaver */

void (*SuspendScreenSaver)(_THIS);

/* Text input */

void (*StartTextInput)(_THIS);

void (*StopTextInput)(_THIS);

void (*SetTextInputRect)(_THIS, const SDL_Rect *rect);

void (*ClearComposition)(_THIS);

SDL_bool (*IsTextInputShown)(_THIS);

/* Screen keyboard */

SDL_bool (*HasScreenKeyboardSupport)(_THIS);

void (*ShowScreenKeyboard)(_THIS, SDL_Window *window);

void (*HideScreenKeyboard)(_THIS, SDL_Window *window);

SDL_bool (*IsScreenKeyboardShown)(_THIS, SDL_Window *window);

/* Clipboard */

int (*SetClipboardText)(_THIS, const char *text);

char *(*GetClipboardText)(_THIS);

SDL_bool (*HasClipboardText)(_THIS);

int (*SetPrimarySelectionText)(_THIS, const char *text);

char *(*GetPrimarySelectionText)(_THIS);

SDL_bool (*HasPrimarySelectionText)(_THIS);

/* MessageBox */

int (*ShowMessageBox)(_THIS, const SDL_MessageBoxData *messageboxdata, int *buttonid);

/* Hit-testing */

int (*SetWindowHitTest)(SDL_Window *window, SDL_bool enabled);

/* Tell window that app enabled drag'n'drop events */

void (*AcceptDragAndDrop)(SDL_Window *window, SDL_bool accept);

/* * * */

/* Data common to all drivers */

SDL_threadID thread;

SDL_bool checked_texture_framebuffer;

SDL_bool is_dummy;

SDL_bool suspend_screensaver;

void *wakeup_window;

int num_displays;

SDL_VideoDisplay *displays;

SDL_Window *windows;

SDL_Window *grabbed_window;

Uint8 window_magic;

Uint32 next_object_id;

char *clipboard_text;

char *primary_selection_text;

SDL_bool setting_display_mode;

Uint32 quirk_flags;

/* * * */

/* Data used by the GL drivers */

struct

{

int red_size;

int green_size;

int blue_size;

int alpha_size;

int depth_size;

int buffer_size;

int stencil_size;

int double_buffer;

int accum_red_size;

int accum_green_size;

int accum_blue_size;

int accum_alpha_size;

int stereo;

int multisamplebuffers;

int multisamplesamples;

int floatbuffers;

int accelerated;

int major_version;

int minor_version;

int flags;

int profile_mask;

int share_with_current_context;

int release_behavior;

int reset_notification;

int framebuffer_srgb_capable;

int no_error;

int retained_backing;

int driver_loaded;

int HAS_GL_ARB_color_buffer_float;

char driver_path[256];

void *dll_handle;

} gl_config;

/* * * */

/* Cache current GL context; don't call the OS when it hasn't changed. */

/* We have the global pointers here so Cocoa continues to work the way

it always has, and the thread-local storage for the general case.

SDL_Window *current_glwin;

SDL_GLContext current_glctx;

SDL_TLSID current_glwin_tls;

SDL_TLSID current_glctx_tls;

/* Flag that stores whether it's allowed to call SDL_GL_MakeCurrent()

* with a NULL window, but a non-NULL context. (Not allowed in most cases,

* except on EGL under some circumstances.) */

SDL_bool gl_allow_no_surface;

/* * * */

/* Data used by the Vulkan drivers */

struct

{

PFN_vkGetInstanceProcAddr vkGetInstanceProcAddr;

PFN_vkEnumerateInstanceExtensionProperties vkEnumerateInstanceExtensionProperties;

int loader_loaded;

char loader_path[256];

void *loader_handle;

} vulkan_config;

/* * * */

/* Data private to this driver */

void *driverdata;

struct SDL_GLDriverData *gl_data;

#ifdef SDL_VIDEO_OPENGL_EGL

struct SDL_EGL_VideoData *egl_data;

#endif

#if defined(SDL_VIDEO_OPENGL_ES) || defined(SDL_VIDEO_OPENGL_ES2)

struct SDL_PrivateGLESData *gles_data;

#endif

/* * * */

/* The function used to dispose of this structure */

void (*free)(_THIS);

};

typedef struct VideoBootStrap

{

const char *name;

const char *desc;

SDL_VideoDevice *(*create)(void);

int (*ShowMessageBox)(const SDL_MessageBoxData *messageboxdata, int *buttonid); /* can be done without initializing backend! */

} VideoBootStrap;

/* Not all of these are available in a given build. Use #ifdefs, etc. */

extern VideoBootStrap COCOA_bootstrap;

extern VideoBootStrap X11_bootstrap;

extern VideoBootStrap DirectFB_bootstrap;

extern VideoBootStrap WINDOWS_bootstrap;

extern VideoBootStrap WINRT_bootstrap;

extern VideoBootStrap HAIKU_bootstrap;

extern VideoBootStrap PND_bootstrap;

extern VideoBootStrap UIKIT_bootstrap;

extern VideoBootStrap Android_bootstrap;

extern VideoBootStrap PS2_bootstrap;

extern VideoBootStrap PSP_bootstrap;

extern VideoBootStrap VITA_bootstrap;

extern VideoBootStrap RISCOS_bootstrap;

extern VideoBootStrap N3DS_bootstrap;

extern VideoBootStrap RPI_bootstrap;

extern VideoBootStrap KMSDRM_bootstrap;

extern VideoBootStrap KMSDRM_LEGACY_bootstrap;

extern VideoBootStrap DUMMY_bootstrap;

extern VideoBootStrap DUMMY_evdev_bootstrap;

extern VideoBootStrap Wayland_bootstrap;

extern VideoBootStrap NACL_bootstrap;

extern VideoBootStrap VIVANTE_bootstrap;

extern VideoBootStrap Emscripten_bootstrap;

extern VideoBootStrap QNX_bootstrap;

extern VideoBootStrap OFFSCREEN_bootstrap;

extern VideoBootStrap NGAGE_bootstrap;

extern VideoBootStrap OS2DIVE_bootstrap;

extern VideoBootStrap OS2VMAN_bootstrap;

/* Use SDL_OnVideoThread() sparingly, to avoid regressions in use cases that currently happen to work */

extern SDL_bool SDL_OnVideoThread(void);

extern SDL_VideoDevice *SDL_GetVideoDevice(void);

extern int SDL_AddBasicVideoDisplay(const SDL_DisplayMode *desktop_mode);

extern int SDL_AddVideoDisplay(const SDL_VideoDisplay *display, SDL_bool send_event);

extern void SDL_DelVideoDisplay(int index);

extern SDL_bool SDL_AddDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode *mode);

extern void SDL_SetCurrentDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode *mode);

extern void SDL_SetDesktopDisplayMode(SDL_VideoDisplay *display, const SDL_DisplayMode *mode);

extern void SDL_ResetDisplayModes(int displayIndex);

extern int SDL_GetIndexOfDisplay(SDL_VideoDisplay *display);

extern SDL_VideoDisplay *SDL_GetDisplay(int displayIndex);

extern SDL_VideoDisplay *SDL_GetDisplayForWindow(SDL_Window *window);

extern void *SDL_GetDisplayDriverData(int displayIndex);

extern SDL_bool SDL_IsVideoContextExternal(void);

extern int SDL_GetMessageBoxCount(void);

extern void SDL_GL_DeduceMaxSupportedESProfile(int *major, int *minor);

extern int SDL_RecreateWindow(SDL_Window *window, Uint32 flags);

extern SDL_bool SDL_HasWindows(void);

extern void SDL_OnWindowShown(SDL_Window *window);

extern void SDL_OnWindowHidden(SDL_Window *window);

extern void SDL_OnWindowMoved(SDL_Window *window);

extern void SDL_OnWindowResized(SDL_Window *window);

extern void SDL_OnWindowLiveResizeUpdate(SDL_Window *window);

extern void SDL_OnWindowMinimized(SDL_Window *window);

extern void SDL_OnWindowRestored(SDL_Window *window);

extern void SDL_OnWindowEnter(SDL_Window *window);

extern void SDL_OnWindowLeave(SDL_Window *window);

extern void SDL_OnWindowFocusGained(SDL_Window *window);

extern void SDL_OnWindowFocusLost(SDL_Window *window);

extern void SDL_UpdateWindowGrab(SDL_Window *window);

extern SDL_Window *SDL_GetFocusWindow(void);

extern SDL_bool SDL_ShouldAllowTopmost(void);

extern float SDL_ComputeDiagonalDPI(int hpix, int vpix, float hinches, float vinches);

extern void SDL_ToggleDragAndDropSupport(void);

extern int SDL_GetPointDisplayIndex(const SDL_Point *point);

extern int SDL_GL_SwapWindowWithResult(SDL_Window *window);

#if defined(SDL_VIDEO_DRIVER_X11) || defined(SDL_VIDEO_DRIVER_WAYLAND) || defined(SDL_VIDEO_DRIVER_EMSCRIPTEN)

const char *SDL_GetCSSCursorName(SDL_SystemCursor id, const char **fallback_name);

#endif

#endif /* SDL_sysvideo_h_ */

/* vi: set ts=4 sw=4 expandtab: */

FilesExpand file tree

SDL_sysvideo.h

Latest commit

History

SDL_sysvideo.h

File metadata and controls