summaryrefslogtreecommitdiffstats
path: root/src/Runtime/Source/Qt3DSRuntimeRender/Include/Qt3DSRenderInputStreamFactory.h
blob: e82134b8b41e14900f417af318930fa2b8e74e1b (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
61
62
63
64
65
66
67
68
69
/****************************************************************************
**
** Copyright (C) 2008-2012 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#pragma once
#ifndef QT3DS_RENDER_INPUT_STREAM_FACTORY_H
#define QT3DS_RENDER_INPUT_STREAM_FACTORY_H
#include "Qt3DSRender.h"
#include "foundation/IOStreams.h"
#include "foundation/Qt3DSRefCounted.h"
#include "EASTL/string.h"

namespace qt3ds {
namespace render {
    class IRefCountedInputStream : public qt3ds::foundation::ISeekableIOStream, public NVRefCounted
    {
    protected:
        virtual ~IRefCountedInputStream() {}
    };
    // This class is threadsafe.
    class IInputStreamFactory : public NVRefCounted
    {
    protected:
        virtual ~IInputStreamFactory() {}
    public:
        // These directories must have a '/' on them
        virtual void AddSearchDirectory(const char8_t *inDirectory) = 0;
        virtual IRefCountedInputStream *GetStreamForFile(const QString &inFilename,
                                                         bool inQuiet = false) = 0;
        // Return a path for this file.  Returns true if GetStreamForFile would return a valid
        // stream.
        // else returns false
        virtual bool GetPathForFile(const QString &inFilename, QString &outFile,
                                    bool inQuiet = false) = 0;

        // Create an input stream factory using this foundation and an platform-optional app
        // directory
        // on android the app directory has no effect; use use the assets bundled with the APK file.
        static IInputStreamFactory &Create(NVFoundationBase &inFoundation);
    };
}
}

#endif