Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | List of all members
DirectX::ScratchImage Class Reference

#include <DirectXTex.h>

Public Member Functions

 ScratchImage ()
 
 ScratchImage (ScratchImage &&moveFrom)
 
 ~ScratchImage ()
 
ScratchImage & operator= (ScratchImage &&moveFrom)
 
HRESULT Initialize (_In_ const TexMetadata &mdata, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT Initialize1D (_In_ DXGI_FORMAT fmt, _In_ size_t length, _In_ size_t arraySize, _In_ size_t mipLevels, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT Initialize2D (_In_ DXGI_FORMAT fmt, _In_ size_t width, _In_ size_t height, _In_ size_t arraySize, _In_ size_t mipLevels, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT Initialize3D (_In_ DXGI_FORMAT fmt, _In_ size_t width, _In_ size_t height, _In_ size_t depth, _In_ size_t mipLevels, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT InitializeCube (_In_ DXGI_FORMAT fmt, _In_ size_t width, _In_ size_t height, _In_ size_t nCubes, _In_ size_t mipLevels, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT InitializeFromImage (_In_ const Image &srcImage, _In_ bool allow1D=false, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT InitializeArrayFromImages (_In_reads_(nImages) const Image *images, _In_ size_t nImages, _In_ bool allow1D=false, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT InitializeCubeFromImages (_In_reads_(nImages) const Image *images, _In_ size_t nImages, _In_ DWORD flags=CP_FLAGS_NONE)
 
HRESULT Initialize3DFromImages (_In_reads_(depth) const Image *images, _In_ size_t depth, _In_ DWORD flags=CP_FLAGS_NONE)
 
void Release ()
 
bool OverrideFormat (_In_ DXGI_FORMAT f)
 
const TexMetadata & GetMetadata () const
 
const Image * GetImage (_In_ size_t mip, _In_ size_t item, _In_ size_t slice) const
 
const Image * GetImages () const
 
size_t GetImageCount () const
 
uint8_t * GetPixels () const
 
size_t GetPixelsSize () const
 
bool IsAlphaAllOpaque () const
 

Detailed Description

Definition at line 233 of file DirectXTex.h.

Constructor & Destructor Documentation

DirectX::ScratchImage::ScratchImage ( )

Definition at line 236 of file DirectXTex.h.

DirectX::ScratchImage::ScratchImage ( ScratchImage &&  moveFrom)

Definition at line 238 of file DirectXTex.h.

DirectX::ScratchImage::~ScratchImage ( )

Definition at line 240 of file DirectXTex.h.

References Release().

Member Function Documentation

const Image* DirectX::ScratchImage::GetImage ( _In_ size_t  mip,
_In_ size_t  item,
_In_ size_t  slice 
) const

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::_ConvertToR32G32B32A32(), DirectX::_ConvertToRGBAF32(), DirectX::_GPUCompress(), DirectX::_PerformFlipRotateViaF32(), DirectX::_PerformResizeViaF32(), DirectX::Compress(), DirectX::ComputeMSE(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtGetImage(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), DirectX::LoadFromTGAFile(), DirectX::LoadFromTGAMemory(), DirectX::PremultiplyAlpha(), and DirectX::Resize().

size_t DirectX::ScratchImage::GetImageCount ( ) const

Definition at line 264 of file DirectXTex.h.

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::Compress(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtGetImageCount(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), DirectX::LoadFromTGAFile(), and DirectX::PremultiplyAlpha().

const Image* DirectX::ScratchImage::GetImages ( ) const

Definition at line 263 of file DirectXTex.h.

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::Compress(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtGetImages(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), and DirectX::PremultiplyAlpha().

const TexMetadata& DirectX::ScratchImage::GetMetadata ( ) const

Definition at line 260 of file DirectXTex.h.

Referenced by dxtGetMetadata(), and DirectX::GenerateMipMaps().

uint8_t* DirectX::ScratchImage::GetPixels ( ) const

Definition at line 266 of file DirectXTex.h.

Referenced by dxtGetPixels(), DirectX::LoadFromDDSFile(), and DirectX::LoadFromTGAFile().

size_t DirectX::ScratchImage::GetPixelsSize ( ) const

Definition at line 267 of file DirectXTex.h.

Referenced by dxtGetPixelsSize(), DirectX::LoadFromDDSFile(), and DirectX::LoadFromTGAFile().

HRESULT DirectX::ScratchImage::Initialize ( _In_ const TexMetadata &  mdata,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::CaptureTexture(), DirectX::Compress(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtInitialize(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), DirectX::LoadFromDDSFile(), DirectX::LoadFromDDSMemory(), DirectX::PremultiplyAlpha(), and DirectX::Resize().

HRESULT DirectX::ScratchImage::Initialize1D ( _In_ DXGI_FORMAT  fmt,
_In_ size_t  length,
_In_ size_t  arraySize,
_In_ size_t  mipLevels,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitialize1D(), DirectX::GenerateMipMaps(), and InitializeArrayFromImages().

HRESULT DirectX::ScratchImage::Initialize2D ( _In_ DXGI_FORMAT  fmt,
_In_ size_t  width,
_In_ size_t  height,
_In_ size_t  arraySize,
_In_ size_t  mipLevels,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::_ConvertToR32G32B32A32(), DirectX::_ConvertToRGBAF32(), DirectX::_PerformFlipRotateViaF32(), DirectX::_PerformResizeViaF32(), DirectX::Compress(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtInitialize2D(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), InitializeArrayFromImages(), DirectX::LoadFromTGAFile(), DirectX::LoadFromTGAMemory(), DirectX::PremultiplyAlpha(), and DirectX::Resize().

HRESULT DirectX::ScratchImage::Initialize3D ( _In_ DXGI_FORMAT  fmt,
_In_ size_t  width,
_In_ size_t  height,
_In_ size_t  depth,
_In_ size_t  mipLevels,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitialize3D().

HRESULT DirectX::ScratchImage::Initialize3DFromImages ( _In_reads_(depth) const Image *  images,
_In_ size_t  depth,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitialize3DFromImages().

_Use_decl_annotations_ HRESULT DirectX::ScratchImage::InitializeArrayFromImages ( _In_reads_(nImages) const Image *  images,
_In_ size_t  nImages,
_In_ bool  allow1D = false,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Definition at line 529 of file DirectXTexImage.cpp.

References DirectX::assert(), DirectX::ComputeScanlines(), DirectX::format, DirectX::Image::format, DirectX::Image::height, Initialize1D(), Initialize2D(), DirectX::nImages, DirectX::Image::pixels, DirectX::Image::rowPitch, DirectX::Image::width, and DirectX::y.

Referenced by dxtInitializeArrayFromImages().

HRESULT DirectX::ScratchImage::InitializeCube ( _In_ DXGI_FORMAT  fmt,
_In_ size_t  width,
_In_ size_t  height,
_In_ size_t  nCubes,
_In_ size_t  mipLevels,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitializeCube().

HRESULT DirectX::ScratchImage::InitializeCubeFromImages ( _In_reads_(nImages) const Image *  images,
_In_ size_t  nImages,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitializeCubeFromImages().

HRESULT DirectX::ScratchImage::InitializeFromImage ( _In_ const Image &  srcImage,
_In_ bool  allow1D = false,
_In_ DWORD  flags = CP_FLAGS_NONE 
)

Referenced by dxtInitializeFromImage().

bool DirectX::ScratchImage::IsAlphaAllOpaque ( ) const

Definition at line 767 of file DirectXTexImage.cpp.

References DirectX::_IsAlphaAllOpaqueBC(), DirectX::_LoadScanline(), DirectX::assert(), DirectX::TexMetadata::format, DirectX::Image::format, DirectX::HasAlpha(), DirectX::Image::height, DirectX::IsCompressed(), DirectX::Image::pixels, DirectX::Image::rowPitch, DirectX::threshold, DirectX::TexMetadata::width, and DirectX::Image::width.

ScratchImage & DirectX::ScratchImage::operator= ( ScratchImage &&  moveFrom)

Definition at line 232 of file DirectXTexImage.cpp.

References Release().

bool DirectX::ScratchImage::OverrideFormat ( _In_ DXGI_FORMAT  f)

Referenced by dxtOverrideFormat().

void DirectX::ScratchImage::Release ( )

Definition at line 667 of file DirectXTexImage.cpp.

Referenced by DirectX::_ConvertFromR32G32B32A32(), DirectX::_ConvertToR32G32B32A32(), DirectX::_ConvertToRGBAF32(), DirectX::_PerformFlipRotateViaF32(), DirectX::_PerformResizeViaF32(), DirectX::CaptureTexture(), DirectX::Compress(), DirectX::ComputeNormalMap(), DirectX::Convert(), DirectX::ConvertToSinglePlane(), DirectX::Decompress(), dxtRelease(), DirectX::FlipRotate(), DirectX::GenerateMipMaps(), DirectX::GenerateMipMaps3D(), DirectX::LoadFromDDSFile(), DirectX::LoadFromDDSMemory(), DirectX::LoadFromTGAFile(), DirectX::LoadFromTGAMemory(), DirectX::LoadFromWICFile(), DirectX::LoadFromWICMemory(), operator=(), DirectX::PremultiplyAlpha(), DirectX::Resize(), and ~ScratchImage().

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