Documentation of SFML 2.6.2

Loading...
Searching...
No Matches
FileInputStream.hpp
1
2//
3// SFML - Simple and Fast Multimedia Library
4// Copyright (C) 2007-2023 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#ifndef SFML_FILEINPUTSTREAM_HPP
26#define SFML_FILEINPUTSTREAM_HPP
27
29// Headers
31#include <SFML/Config.hpp>
32#include <SFML/System/Export.hpp>
33#include <SFML/System/InputStream.hpp>
34#include <SFML/System/NonCopyable.hpp>
35#include <cstdio>
36#include <string>
37
38#ifdef SFML_SYSTEM_ANDROID
39namespace sf
40{
41namespace priv
42{
43class SFML_SYSTEM_API ResourceStream;
44}
45}
46#endif
47
48
49namespace sf
50{
55class SFML_SYSTEM_API FileInputStream : public InputStream, NonCopyable
56{
57public:
62 FileInputStream();
63
68 virtual ~FileInputStream();
69
78 bool open(const std::string& filename);
79
92 virtual Int64 read(void* data, Int64 size);
93
102 virtual Int64 seek(Int64 position);
103
110 virtual Int64 tell();
111
118 virtual Int64 getSize();
119
120private:
121
123 // Member data
125#ifdef SFML_SYSTEM_ANDROID
126 priv::ResourceStream* m_file;
127#else
128 std::FILE* m_file;
129#endif
130};
131
132} // namespace sf
133
134
135#endif // SFML_FILEINPUTSTREAM_HPP
136
137
sf::FileInputStream
Implementation of input stream based on a file.
Definition FileInputStream.hpp:56
sf::FileInputStream::tell
virtual Int64 tell()
Get the current reading position in the stream.
sf::FileInputStream::open
bool open(const std::string &filename)
Open the stream from a file path.
sf::FileInputStream::FileInputStream
FileInputStream()
Default constructor.
sf::FileInputStream::getSize
virtual Int64 getSize()
Return the size of the stream.
sf::FileInputStream::seek
virtual Int64 seek(Int64 position)
Change the current reading position.
sf::FileInputStream::read
virtual Int64 read(void *data, Int64 size)
Read data from the stream.
sf::FileInputStream::~FileInputStream
virtual ~FileInputStream()
Default destructor.
sf::InputStream
Abstract class for custom file input streams.
Definition InputStream.hpp:42
sf::NonCopyable
Utility class that makes any derived class non-copyable.
Definition NonCopyable.hpp:42