texture.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_IMAGING_GLF_TEXTURE_H
#define PXR_IMAGING_GLF_TEXTURE_H
 
 
#include "pxr/pxr.h"
#include "pxr/imaging/glf/api.h"
#include "pxr/imaging/hio/image.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/refPtr.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/weakPtr.h"
#include "pxr/base/vt/dictionary.h"
 
#include "pxr/imaging/garch/glApi.h"
 
#include <map>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
#define GLF_TEXTURE_TOKENS                      \
    (texels)                                    \
    (layout)
 
TF_DECLARE_PUBLIC_TOKENS(GlfTextureTokens, GLF_API, GLF_TEXTURE_TOKENS);
 
TF_DECLARE_WEAK_AND_REF_PTRS(GlfTexture);
 
class GlfTexture : public TfRefBase, public TfWeakBase
{
public:
    struct Binding {
        Binding(TfToken name, TfToken role, GLenum target,
                GLuint textureId, GLuint samplerId)
            : name(name)
            , role(role)
            , target(target)
            , textureId(textureId)
            , samplerId(samplerId) { }
 
            TfToken name;
            TfToken role;
            GLenum target;
            GLuint textureId;
            GLuint samplerId;
    };
    typedef std::vector<Binding> BindingVector;
 
    GLF_API
    virtual ~GlfTexture() = 0;
 
    // Disallow copies
    GlfTexture(const GlfTexture&) = delete;
    GlfTexture& operator=(const GlfTexture&) = delete;
 
    virtual BindingVector GetBindings(TfToken const & identifier,
                                      GLuint samplerId = 0) = 0;
 
    virtual GLuint GetGlTextureName() = 0;
 
    GLF_API
    size_t GetMemoryUsed() const;
    
    GLF_API
    size_t GetMemoryRequested() const;
 
    GLF_API
    void SetMemoryRequested(size_t targetMemory);
 
    virtual VtDictionary GetTextureInfo(bool forceLoad) = 0;
 
    GLF_API
    virtual bool IsMinFilterSupported(GLenum filter);
 
    GLF_API
    virtual bool IsMagFilterSupported(GLenum filter);
 
    GLF_API
    static size_t GetTextureMemoryAllocated();
 
    GLF_API
    size_t GetContentsID() const;
 
    GLF_API
    HioImage::ImageOriginLocation GetOriginLocation() const;
 
    GLF_API
    bool IsOriginLowerLeft() const;
 
protected:
    GLF_API
    GlfTexture();
 
    GLF_API
    GlfTexture(HioImage::ImageOriginLocation originLocation);
 
    GLF_API
    void _SetMemoryUsed(size_t size);
    
    GLF_API
    virtual void _OnMemoryRequestedDirty();
 
    GLF_API
    void _UpdateContentsID();
    
private:
    size_t _memoryUsed;
    size_t _memoryRequested;
    size_t _contentsID;
    HioImage::ImageOriginLocation _originLocation;
};
 
class GlfTextureFactoryBase : public TfType::FactoryBase {
public:
    virtual GlfTextureRefPtr New(const TfToken& texturePath,
                        HioImage::ImageOriginLocation originLocation) const = 0;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif  // PXR_IMAGING_GLF_TEXTURE_H