Cinder  0.8.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Protected Attributes | Friends | List of all members
cinder::dx::Texture::Format Struct Reference

#include <DxTexture.h>

Public Member Functions

 Format ()
 Default constructor, sets the target to GL_TEXTURE_2D, wrap to GL_CLAMP, disables mipmapping, the internal format to "automatic". More...
 
void enableMipmapping (bool enableMipmapping=true)
 Specifies the texture's target. The default is GL_TEXTURE_2D. More...
 
void setInternalFormat (DXGI_FORMAT internalFormat)
 Sets the Texture's internal format. A value of -1 implies selecting the best format for the context. More...
 
void setAutoInternalFormat ()
 Sets the Texture's internal format to be automatically selected based on the context. More...
 
void setWrap (D3D11_TEXTURE_ADDRESS_MODE wrapS, D3D11_TEXTURE_ADDRESS_MODE wrapT)
 Sets the wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP. More...
 
void setWrapS (D3D11_TEXTURE_ADDRESS_MODE wrapS)
 Sets the horizontal wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP_TO_EDGE. More...
 
void setWrapT (D3D11_TEXTURE_ADDRESS_MODE wrapT)
 Sets the vertical wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP_TO_EDGE. More...
 
void setFilter (D3D11_FILTER filter)
 Sets the filtering behavior when a texture is displayed at a lower resolution than its native resolution. Default is GL_LINEAR Possible values are. More...
 
bool hasMipmapping () const
 Returns the texture's target. More...
 
DXGI_FORMAT getInternalFormat () const
 Returns the Texture's internal format. A value of -1 implies automatic selection of the internal format based on the context. More...
 
bool isAutoInternalFormat () const
 Returns whether the Texture's internal format will be automatically selected based on the context. More...
 
D3D11_TEXTURE_ADDRESS_MODE getWrapS () const
 Returns the horizontal wrapping behavior for the texture coordinates. More...
 
D3D11_TEXTURE_ADDRESS_MODE getWrapT () const
 Returns the vertical wrapping behavior for the texture coordinates. More...
 
D3D11_FILTER getFilter () const
 Returns the texture minifying function, which is used whenever the pixel being textured maps to an area greater than one texture element. More...
 
bool isRenderTarget () const
 Returns true if render target flag is set. More...
 
void enableRenderTarget (bool bEnableRenderTarget=true)
 Enables or disables render target. Default is disabled. More...
 

Protected Attributes

D3D11_TEXTURE_ADDRESS_MODE mWrapS
 
D3D11_TEXTURE_ADDRESS_MODE mWrapT
 
D3D11_FILTER mFilter
 
bool mMipmapping
 
DXGI_FORMAT mInternalFormat
 
bool mRenderTarget
 

Friends

class Texture
 

Constructor & Destructor Documentation

cinder::dx::Texture::Format::Format ( )

Default constructor, sets the target to GL_TEXTURE_2D, wrap to GL_CLAMP, disables mipmapping, the internal format to "automatic".

Member Function Documentation

void cinder::dx::Texture::Format::enableMipmapping ( bool  enableMipmapping = true)

Specifies the texture's target. The default is GL_TEXTURE_2D.

Sets the texture's target to be GL_TEXTURE_RECTANGLE_ARB. Not available in OpenGL ES. Enables or disables mipmapping. Default is disabled.

void cinder::dx::Texture::Format::setInternalFormat ( DXGI_FORMAT  internalFormat)

Sets the Texture's internal format. A value of -1 implies selecting the best format for the context.

void cinder::dx::Texture::Format::setAutoInternalFormat ( )

Sets the Texture's internal format to be automatically selected based on the context.

void cinder::dx::Texture::Format::setWrap ( D3D11_TEXTURE_ADDRESS_MODE  wrapS,
D3D11_TEXTURE_ADDRESS_MODE  wrapT 
)

Sets the wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP.

void cinder::dx::Texture::Format::setWrapS ( D3D11_TEXTURE_ADDRESS_MODE  wrapS)

Sets the horizontal wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP_TO_EDGE.

void cinder::dx::Texture::Format::setWrapT ( D3D11_TEXTURE_ADDRESS_MODE  wrapT)

Sets the vertical wrapping behavior when a texture coordinate falls outside the range of [0,1]. Possible values are GL_CLAMP, GL_REPEAT and GL_CLAMP_TO_EDGE. The default is GL_CLAMP_TO_EDGE.

void cinder::dx::Texture::Format::setFilter ( D3D11_FILTER  filter)

Sets the filtering behavior when a texture is displayed at a lower resolution than its native resolution. Default is GL_LINEAR Possible values are.

  • GL_NEAREST
  • GL_LINEAR
  • GL_NEAREST_MIPMAP_NEAREST
  • GL_LINEAR_MIPMAP_NEAREST
  • GL_NEAREST_MIPMAP_LINEAR
  • GL_LINEAR_MIPMAP_LINEAR
bool cinder::dx::Texture::Format::hasMipmapping ( ) const

Returns the texture's target.

Returns whether the texture has mipmapping enabled

DXGI_FORMAT cinder::dx::Texture::Format::getInternalFormat ( ) const

Returns the Texture's internal format. A value of -1 implies automatic selection of the internal format based on the context.

bool cinder::dx::Texture::Format::isAutoInternalFormat ( ) const

Returns whether the Texture's internal format will be automatically selected based on the context.

D3D11_TEXTURE_ADDRESS_MODE cinder::dx::Texture::Format::getWrapS ( ) const

Returns the horizontal wrapping behavior for the texture coordinates.

D3D11_TEXTURE_ADDRESS_MODE cinder::dx::Texture::Format::getWrapT ( ) const

Returns the vertical wrapping behavior for the texture coordinates.

D3D11_FILTER cinder::dx::Texture::Format::getFilter ( ) const

Returns the texture minifying function, which is used whenever the pixel being textured maps to an area greater than one texture element.

bool cinder::dx::Texture::Format::isRenderTarget ( ) const

Returns true if render target flag is set.

void cinder::dx::Texture::Format::enableRenderTarget ( bool  bEnableRenderTarget = true)

Enables or disables render target. Default is disabled.

Friends And Related Function Documentation

friend class Texture
friend

Member Data Documentation

D3D11_TEXTURE_ADDRESS_MODE cinder::dx::Texture::Format::mWrapS
protected
D3D11_TEXTURE_ADDRESS_MODE cinder::dx::Texture::Format::mWrapT
protected
D3D11_FILTER cinder::dx::Texture::Format::mFilter
protected
bool cinder::dx::Texture::Format::mMipmapping
protected
DXGI_FORMAT cinder::dx::Texture::Format::mInternalFormat
protected
bool cinder::dx::Texture::Format::mRenderTarget
protected

The documentation for this struct was generated from the following files: