aboutsummaryrefslogtreecommitdiff
path: root/pugl/pugl/pugl_stub.h
blob: ef480005d798396860f40249847856bea058ac7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
  Copyright 2019-2020 David Robillard <d@drobilla.net>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/**
   @file pugl_stub.h
   @brief Stub backend functions and accessor declaration.
*/

#ifndef PUGL_PUGL_STUB_H
#define PUGL_PUGL_STUB_H

#include "pugl/pugl.h"

PUGL_BEGIN_DECLS

/**
   @defgroup stub Stub

   Stub graphics backend.

   The stub backend functions do nothing and always
   return success.  These do not make for a usable backend on their own since
   the platform implementation would fail to create a window, but are useful
   for other backends to reuse since not all need non-trivial implementations
   of every backend function.

   @ingroup pugl_c
   @{
*/

/**
   Stub graphics backend.

   This backend just creates a simple native window without setting up any
   portable graphics API.
*/
PUGL_API
const PuglBackend*
puglStubBackend(void);

/**
   @}
*/

PUGL_END_DECLS

#endif // PUGL_PUGL_STUB_H