RenderManAPI  24.0
RtxPlugin::TextureCtx Struct Reference

TextureCtx provides initial defining properties for textures generated by this plugin. More...

#include <RtxPlugin.h>

Classes

struct  layerSpec
 Plugin fills in the names and channel-count of the layers associated with this texture. More...
 

Public Types

enum  WrapMode { k_Black = 0, k_Clamp, k_Periodic }
 The wrap mode applied at the edges of max resolution. More...
 
enum  DataType { k_Byte = 0, k_Float }
 The type of the data provided by the texture. More...
 
enum  PyramidType { k_Single = 0, k_MIP, k_RIP }
 What type of pyramid should be used? More...
 

Public Attributes

int numChannels
 This is the total number of channels present. More...
 
unsigned int numLayers
 The maximum # of layers this texture can access. More...
 
struct RtxPlugin::TextureCtx::layerSpec ** layers
 
Int2D minRes
 The min,max resolution requested for this texture. More...
 
Int2D maxRes
 
enum RtxPlugin::TextureCtx::WrapMode sWrap
 
enum RtxPlugin::TextureCtx::WrapMode tWrap
 
enum RtxPlugin::TextureCtx::DataType dataType
 
enum RtxPlugin::TextureCtx::PyramidType pyramidType
 
bool isLocked
 Should the tile be locked while filling? (not thread safe?) More...
 
unsigned int argc
 Read-only texture args, they come in pairs, memory is owned by the renderer. More...
 
const char ** argv
 
void * userData
 The plugin can use this field to stash its own instance data. More...
 
bool retryOnError
 

Detailed Description

TextureCtx provides initial defining properties for textures generated by this plugin.

Each plugin should fill this structure during an Open() method call. Open() is called for each unique instance of a given texture() call in the shader. A unique instance is defined by the string passed to the file parameter of the texture() SL call. NOTE: The Open() method may be called multiple times for a texture as will Close(). On a Close() all resources should be released, and on an Open() they are safe to reaquire.

Member Enumeration Documentation

◆ DataType

The type of the data provided by the texture.

Enumerator
k_Byte 
k_Float 

◆ PyramidType

What type of pyramid should be used?

Enumerator
k_Single 
k_MIP 
k_RIP 

◆ WrapMode

The wrap mode applied at the edges of max resolution.

Enumerator
k_Black 
k_Clamp 
k_Periodic 

Member Data Documentation

◆ argc

unsigned int RtxPlugin::TextureCtx::argc

Read-only texture args, they come in pairs, memory is owned by the renderer.

◆ argv

const char** RtxPlugin::TextureCtx::argv

◆ dataType

enum RtxPlugin::TextureCtx::DataType RtxPlugin::TextureCtx::dataType

◆ isLocked

bool RtxPlugin::TextureCtx::isLocked

Should the tile be locked while filling? (not thread safe?)

◆ layers

struct RtxPlugin::TextureCtx::layerSpec * * RtxPlugin::TextureCtx::layers

◆ maxRes

Int2D RtxPlugin::TextureCtx::maxRes

◆ minRes

Int2D RtxPlugin::TextureCtx::minRes

The min,max resolution requested for this texture.

◆ numChannels

int RtxPlugin::TextureCtx::numChannels

This is the total number of channels present.

◆ numLayers

unsigned int RtxPlugin::TextureCtx::numLayers

The maximum # of layers this texture can access.

◆ pyramidType

enum RtxPlugin::TextureCtx::PyramidType RtxPlugin::TextureCtx::pyramidType

◆ retryOnError

bool RtxPlugin::TextureCtx::retryOnError

◆ sWrap

enum RtxPlugin::TextureCtx::WrapMode RtxPlugin::TextureCtx::sWrap

◆ tWrap

enum RtxPlugin::TextureCtx::WrapMode RtxPlugin::TextureCtx::tWrap

◆ userData

void* RtxPlugin::TextureCtx::userData

The plugin can use this field to stash its own instance data.

The plugin manages ownership.


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