1/**
2 * Copyright (c) 2006-2023 LOVE Development Team
3 *
4 * This software is provided 'as-is', without any express or implied
5 * warranty. In no event will the authors be held liable for any damages
6 * arising from the use of this software.
7 *
8 * Permission is granted to anyone to use this software for any purpose,
9 * including commercial applications, and to alter it and redistribute it
10 * freely, subject to the following restrictions:
11 *
12 * 1. The origin of this software must not be misrepresented; you must not
13 * claim that you wrote the original software. If you use this software
14 * in a product, an acknowledgment in the product documentation would be
15 * appreciated but is not required.
16 * 2. Altered source versions must be plainly marked as such, and must not be
17 * misrepresented as being the original software.
18 * 3. This notice may not be removed or altered from any source distribution.
19 **/
20
21#ifndef LOVE_STREAM_H
22#define LOVE_STREAM_H
23
24// LOVE
25#include <stddef.h>
26#include "Object.h"
27
28namespace love
29{
30
31class Stream : public Object
32{
33public:
34 static love::Type type;
35
36 virtual ~Stream() {}
37
38 // getData and getSize are assumed to talk about
39 // the buffer
40
41 /**
42 * A callback, gets called when some Stream consumer exhausts the data
43 **/
44 virtual void fillBackBuffer() {}
45
46 /**
47 * Get the front buffer, Streams are supposed to be (at least) double-buffered
48 **/
49 virtual const void *getFrontBuffer() const = 0;
50
51 /**
52 * Get the size of any (and in particular the front) buffer
53 **/
54 virtual size_t getSize() const = 0;
55
56 /**
57 * Swap buffers. Returns true if there is new data in the front buffer,
58 * false otherwise.
59 * NOTE: If there is no back buffer ready, this call must be ignored
60 **/
61 virtual bool swapBuffers() = 0;
62}; // Stream
63
64} // love
65
66#endif // LOVE_STREAM_H
67