Loading...
Searching...
No Matches
MemoryInputStream.hpp
Go to the documentation of this file.
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages 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 freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25#pragma once
26
28// Headers
30#include <SFML/Config.hpp>
31
32#include <SFML/System/Export.hpp>
33
34#include <SFML/System/InputStream.hpp>
35
36#include <cstddef>
37#include <cstdint>
38
39
40namespace sf
41{
46class SFML_SYSTEM_API MemoryInputStream : public InputStream
47{
48public:
56 MemoryInputStream(const void* data, std::size_t sizeInBytes);
57
70 [[nodiscard]] std::optional<std::size_t> read(void* data, std::size_t size) override;
71
80 [[nodiscard]] std::optional<std::size_t> seek(std::size_t position) override;
81
88 [[nodiscard]] std::optional<std::size_t> tell() override;
89
96 std::optional<std::size_t> getSize() override;
97
98private:
100 // Member data
102 const std::byte* m_data{};
103 std::size_t m_size{};
104 std::size_t m_offset{};
105};
106
107} // namespace sf
108
109
SFML_SYSTEM_API
#define SFML_SYSTEM_API
Definition System/Export.hpp:42
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:46
sf::MemoryInputStream
Implementation of input stream based on a memory chunk.
Definition MemoryInputStream.hpp:47
sf::MemoryInputStream::read
std::optional< std::size_t > read(void *data, std::size_t size) override
Read data from the stream.
sf::MemoryInputStream::MemoryInputStream
MemoryInputStream(const void *data, std::size_t sizeInBytes)
Construct the stream from its data.
sf::MemoryInputStream::seek
std::optional< std::size_t > seek(std::size_t position) override
Change the current reading position.
sf::MemoryInputStream::getSize
std::optional< std::size_t > getSize() override
Return the size of the stream.
sf::MemoryInputStream::tell
std::optional< std::size_t > tell() override
Get the current reading position in the stream.