SDL
2.0
SDL_metal.h
Go to the documentation of this file.
1
/*
2
Simple DirectMedia Layer
3
Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
4
5
This software is provided 'as-is', without any express or implied
6
warranty. In no event will the authors be held liable for any damages
7
arising from the use of this software.
8
9
Permission is granted to anyone to use this software for any purpose,
10
including commercial applications, and to alter it and redistribute it
11
freely, subject to the following restrictions:
12
13
1. The origin of this software must not be misrepresented; you must not
14
claim that you wrote the original software. If you use this software
15
in a product, an acknowledgment in the product documentation would be
16
appreciated but is not required.
17
2. Altered source versions must be plainly marked as such, and must not be
18
misrepresented as being the original software.
19
3. This notice may not be removed or altered from any source distribution.
20
*/
21
22
/**
23
* # CategoryMetal
24
*
25
* Header file for functions to creating Metal layers and views on SDL
26
* windows.
27
*/
28
29
#ifndef SDL_metal_h_
30
#define SDL_metal_h_
31
32
#include "
SDL_video.h
"
33
34
#include "
begin_code.h
"
35
/* Set up for C function definitions, even when using C++ */
36
#ifdef __cplusplus
37
extern
"C"
{
38
#endif
39
40
/**
41
* A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
42
*
43
* This can be cast directly to an NSView or UIView.
44
*/
45
typedef
void
*
SDL_MetalView
;
46
47
/**
48
* \name Metal support functions
49
*/
50
/* @{ */
51
52
/**
53
* Create a CAMetalLayer-backed NSView/UIView and attach it to the specified
54
* window.
55
*
56
* On macOS, this does *not* associate a MTLDevice with the CAMetalLayer on
57
* its own. It is up to user code to do that.
58
*
59
* The returned handle can be casted directly to a NSView or UIView. To access
60
* the backing CAMetalLayer, call SDL_Metal_GetLayer().
61
*
62
* \since This function is available since SDL 2.0.12.
63
*
64
* \sa SDL_Metal_DestroyView
65
* \sa SDL_Metal_GetLayer
66
*/
67
extern
DECLSPEC
SDL_MetalView
SDLCALL
SDL_Metal_CreateView
(
SDL_Window
* window);
68
69
/**
70
* Destroy an existing SDL_MetalView object.
71
*
72
* This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was
73
* called after SDL_CreateWindow.
74
*
75
* \since This function is available since SDL 2.0.12.
76
*
77
* \sa SDL_Metal_CreateView
78
*/
79
extern
DECLSPEC
void
SDLCALL
SDL_Metal_DestroyView
(
SDL_MetalView
view);
80
81
/**
82
* Get a pointer to the backing CAMetalLayer for the given view.
83
*
84
* \since This function is available since SDL 2.0.14.
85
*
86
* \sa SDL_Metal_CreateView
87
*/
88
extern
DECLSPEC
void
*SDLCALL
SDL_Metal_GetLayer
(
SDL_MetalView
view);
89
90
/**
91
* Get the size of a window's underlying drawable in pixels (for use with
92
* setting viewport, scissor & etc).
93
*
94
* \param window SDL_Window from which the drawable size should be queried.
95
* \param w Pointer to variable for storing the width in pixels, may be NULL.
96
* \param h Pointer to variable for storing the height in pixels, may be NULL.
97
*
98
* \since This function is available since SDL 2.0.14.
99
*
100
* \sa SDL_GetWindowSize
101
* \sa SDL_CreateWindow
102
*/
103
extern
DECLSPEC
void
SDLCALL
SDL_Metal_GetDrawableSize
(
SDL_Window
* window,
int
*w,
104
int
*h);
105
106
/* @} */
/* Metal support functions */
107
108
/* Ends C function definitions when using C++ */
109
#ifdef __cplusplus
110
}
111
#endif
112
#include "
close_code.h
"
113
114
#endif
/* SDL_metal_h_ */
SDL_MetalView
void * SDL_MetalView
Definition
SDL_metal.h:45
SDL_Metal_GetLayer
void * SDL_Metal_GetLayer(SDL_MetalView view)
SDL_Metal_DestroyView
void SDL_Metal_DestroyView(SDL_MetalView view)
SDL_Metal_CreateView
SDL_MetalView SDL_Metal_CreateView(SDL_Window *window)
SDL_Metal_GetDrawableSize
void SDL_Metal_GetDrawableSize(SDL_Window *window, int *w, int *h)
SDL_video.h
SDL_Window
struct SDL_Window SDL_Window
Definition
SDL_video.h:95
begin_code.h
close_code.h
include
SDL_metal.h
Generated by
1.9.8