ai_texture.h

Go to the documentation of this file.

// Copyright 2021 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
 
#pragma once
#include "ai_allocate.h"
#include "ai_api.h"
#include "ai_color.h"
#include "ai_shaderglobals.h"
 
// forward declares
class AtUniverse;
 
#define AI_WRAP_PERIODIC          0   
#define AI_WRAP_BLACK             1   
#define AI_WRAP_CLAMP             2   
#define AI_WRAP_MIRROR            3   
#define AI_WRAP_FILE              4   
/*\}*/
 
#define AI_TEXTURE_CLOSEST        0  
#define AI_TEXTURE_BILINEAR       1  
#define AI_TEXTURE_BICUBIC        2  
#define AI_TEXTURE_SMART_BICUBIC  3  
/*\}*/
 
#define AI_TEXTURE_MIPMODE_DEFAULT      0  
#define AI_TEXTURE_MIPMODE_NONE         1  
#define AI_TEXTURE_MIPMODE_ONE          2  
#define AI_TEXTURE_MIPMODE_TRILINEAR    3  
#define AI_TEXTURE_MIPMODE_ANISOTROPIC  4  
/*\}*/
 
struct AtTextureParams {
   float    fill;               
   uint8_t  filter         : 2; 
   uint8_t  wrap_s         : 3; 
   uint8_t  wrap_t         : 3; 
   uint8_t  start_channel;      
   int8_t   mipmap_bias;        
   uint8_t  mipmap_mode    : 3; 
   bool     single_channel : 1; 
   bool     flip_s         : 1; 
   bool     flip_t         : 1; 
   bool     swap_st        : 1; 
   float    scale_s;            
   float    scale_t;            
   float    width_s;            
   float    width_t;            
   float    blur_s;             
   float    blur_t;             
};
 
AI_API void AiTextureParamsSetDefaults(AtTextureParams& params);
 
struct AtTextureHandle;
 
struct AtImage
{
   void*   buffer      = nullptr; 
   int     width       = 0;       
   int     height      = 0;       
   int     full_width  = 0; 
   int     full_height = 0; 
   int     x           = 0; 
   int     y           = 0; 
   int     channels    = 0; 
   uint8_t format = 0; 
   AtArray* aov_names = nullptr; 
   ~AtImage()
   {
      AiFree(aov_names);
      AiFree(buffer);
   }
};
 
AI_API AtTextureHandle*    AiTextureHandleCreate(const char* filename, AtString color_space = AtString());
AI_API AtRGBA              AiTextureHandleAccess(const AtShaderGlobals* sg, AtTextureHandle* handle, const AtTextureParams& params, bool* success = NULL);
AI_API void                AiTextureHandleDestroy(AtTextureHandle* handle);
 
AI_API         AtRGBA      AiTextureAccess(const AtShaderGlobals* sg, AtString filename, AtString color_space, const AtTextureParams& params, bool* success = NULL);
AI_API         bool        AiTextureLoad(const AtString filename, const bool use_float, const unsigned int miplevel, void* image);
AI_API         bool        AiTextureGetResolution(const char* filename, unsigned int* width, unsigned int* height);
AI_API         bool        AiTextureGetNumChannels(const char* filename, unsigned int* num_channels);
AI_API AI_PURE const char* AiTextureGetChannelName(const char* filename, unsigned int channel_index);
AI_API         bool        AiTextureGetFormat(const char* filename, unsigned int* format);
AI_API         bool        AiTextureGetBitDepth(const char* filename, unsigned int* bit_depth);
AI_API         bool        AiTextureGetMatrices(const char* filename, AtMatrix& world_to_screen, AtMatrix& world_to_camera);
AI_API         void        AiTextureInvalidate(const char* filename);
 
AI_API         AtString    AiTextureGetTxFileName(const char* filename, AtString texture_color_space, AtString render_color_space, const AtUniverse* universe);
AI_API         AtString    AiTextureAutoTxFlags(const char* texture_file, AtString texture_color_space, const AtUniverse* universe);
 
AI_API               bool AiReadImage(const char* filename, const uint8_t format, AtImage& image, AtParamValueMap* params = nullptr);
AI_API               bool AiWriteImage(const char* filename, const AtImage& image, AtParamValueMap* params = nullptr);
AI_API               bool AiResizeImage(const AtImage& inImage, AtImage& outImage, AtParamValueMap* params = nullptr);
inline AI_DEPRECATED bool AiLoadImage(const char* filename, const uint8_t format, AtImage& image)
{
   return AiReadImage(filename, format, image, nullptr);
}
 
enum AtMakeTxStatus { AiTxPending, AiTxError, AiTxUpdated, AiTxUpdate_unneeded, AiTxAborted };
 
AI_API         void        AiMakeTx(const char* filename, const char* flags, const AtUniverse* universe = NULL);
AI_API         unsigned    AiMakeTxWaitJob(AtMakeTxStatus*& statuses, const char**& source_files, unsigned int& num_submitted_textures);
AI_API         void        AiMakeTxAbort(AtMakeTxStatus*& statuses, const char**& source_files, unsigned int& num_submitted_textures);
/*\}*/