Cortex  10.0.0-a4
Public Member Functions | List of all members
IECoreGL::LuminanceTexture Class Reference

#include <LuminanceTexture.h>

+ Inheritance diagram for IECoreGL::LuminanceTexture:

Public Member Functions

 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::LuminanceTexture, LuminanceTextureTypeId, Texture)
 
 LuminanceTexture (unsigned int width, unsigned int height, const IECore::Data *y, const IECore::Data *a=nullptr, bool mipMap=true)
 
 LuminanceTexture (const IECoreImage::ImagePrimitive *image, bool mipMap=true)
 
IECoreImage::ImagePrimitivePtr imagePrimitive () const override
 Creates an ImagePrimitive using the texture contents.
 
- Public Member Functions inherited from IECoreGL::Texture
 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::Texture, TextureTypeId, Bindable)
 
 Texture (GLuint texture)
 
void bind () const override
 Binds the texture as the current GL texture.
 
- Public Member Functions inherited from IECoreGL::Bindable
 IE_CORE_DECLARERUNTIMETYPEDEXTENSION (IECoreGL::Bindable, BindableTypeId, IECore::RunTimeTyped)
 
- Public Member Functions inherited from IECore::RunTimeTyped
 IE_CORE_DECLAREMEMBERPTR (RunTimeTyped)
 
virtual TypeId typeId () const
 
virtual const char * typeName () const
 
virtual bool isInstanceOf (TypeId typeId) const
 
virtual bool isInstanceOf (const char *typeName) const
 
- Public Member Functions inherited from IECore::RefCounted
 IE_CORE_DECLAREMEMBERPTR (RefCounted)
 
void addRef () const
 Add a reference to the current object.
 
void removeRef () const
 Remove a reference from the current object.
 
RefCount refCount () const
 Returns the current reference count.
 

Additional Inherited Members

- Public Types inherited from IECore::RunTimeTyped
typedef RefCounted BaseClass
 A typedef for the class this class derives from. All RunTimeTyped classes define this typedef.
 
- Public Types inherited from IECore::RefCounted
typedef size_t RefCount
 
- Static Public Member Functions inherited from IECore::RunTimeTyped
static TypeId staticTypeId ()
 Returns the TypeId for this class, without needing an instance.
 
static const char * staticTypeName ()
 Returns the type name for this class, without needing an instance.
 
static TypeId baseTypeId ()
 
static const char * baseTypeName ()
 
static bool inheritsFrom (TypeId typeId)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (const char *typeName)
 Returns true if this class inherits from the specified type.
 
static bool inheritsFrom (TypeId type, TypeId baseType)
 Returns true if type inherits from baseType.
 
static bool inheritsFrom (const char *typeName, const char *baseTypeName)
 Returns true if typeName inherits from baseTypeName.
 
static TypeId baseTypeId (TypeId typeId)
 Returns the base type of the given type, or InvalidTypeId if no such base exists.
 
static const std::vector< TypeId > & baseTypeIds (TypeId typeId)
 
static const std::set< TypeId > & derivedTypeIds (TypeId typeId)
 
static TypeId typeIdFromTypeName (const char *typeName)
 
static const char * typeNameFromTypeId (TypeId typeId)
 
static void registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId)
 Allows external modules to register their own type ids.
 
- Protected Types inherited from IECore::RunTimeTyped
typedef std::map< TypeId, TypeIdBaseTypeRegistryMap
 
typedef std::map< TypeId, std::vector< TypeId > > BaseTypesRegistryMap
 
typedef std::map< TypeId, std::set< TypeId > > DerivedTypesRegistryMap
 
typedef tbb::spin_rw_mutex Mutex
 
typedef std::map< TypeId, std::string > TypeIdsToTypeNamesMap
 
typedef std::map< std::string, TypeIdTypeNamesToTypeIdsMap
 
- Static Protected Member Functions inherited from IECore::RunTimeTyped
static BaseTypeRegistryMap & baseTypeRegistry ()
 
static DerivedTypesRegistryMap & derivedTypesRegistry ()
 
static BaseTypesRegistryMap & completeBaseTypesRegistry ()
 
static DerivedTypesRegistryMap & completeDerivedTypesRegistry ()
 
static void derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &)
 
static TypeIdsToTypeNamesMap & typeIdsToTypeNames ()
 
static TypeNamesToTypeIdsMap & typeNamesToTypeIds ()
 
- Protected Attributes inherited from IECoreGL::Texture
GLuint m_texture
 Derived classes must set this in their constructor.
 
- Static Protected Attributes inherited from IECore::RunTimeTyped
static Mutex g_baseTypeIdsMutex
 
static Mutex g_derivedTypeIdsMutex
 

Detailed Description

The LuminanceTexture class represents a texture with a single luminance channel and an optional alpha channel.

Constructor & Destructor Documentation

IECoreGL::LuminanceTexture::LuminanceTexture ( unsigned int  width,
unsigned int  height,
const IECore::Data y,
const IECore::Data a = nullptr,
bool  mipMap = true 
)

Constructs a new LuminanceTexture. Both channels must be of the same type, and must be some form of numeric VectorData. The alpha channel may be omitted.

IECoreGL::LuminanceTexture::LuminanceTexture ( const IECoreImage::ImagePrimitive *  image,
bool  mipMap = true 
)

Creates a LuminanceTexture from the specified image. Accepts channels with names "Y" and "A". Currently ignores the display window and uses only the data window. Image must have at least the "Y" channel and if specified the "A" channel must be of the same type.


The documentation for this class was generated from the following file: