API Documentation
Public Member Functions | Public Attributes | List of all members
nkGraphics::MapRequestDescriptor Struct Reference

A description of a request to map a resource. More...

Public Member Functions

 MapRequestDescriptor ()=default
 
 MapRequestDescriptor (MAP mapType, unsigned int bufferSubResourceIndex)
 
 MapRequestDescriptor (MAP mapType, unsigned int textureIndexInArray, unsigned int textureMipIndex)
 

Public Attributes

MAP _mapType = MAP_WRITE_DISCARD
 The map type requested.
 
union {
   BufferSubResourceDescriptor   _buffer
 If the request is made to map a buffer, this member should be populated.
 
   TextureSubResourceDescriptor   _texture = TextureSubResourceDescriptor()
 If the request is made to map a texture, this member should be populated.
 
}; 
 

Detailed Description

A description of a request to map a resource.

Constructor & Destructor Documentation

◆ MapRequestDescriptor() [1/3]

nkGraphics::MapRequestDescriptor::MapRequestDescriptor ( )
default

Default constructor.

◆ MapRequestDescriptor() [2/3]

nkGraphics::MapRequestDescriptor::MapRequestDescriptor ( MAP  mapType,
unsigned int  bufferSubResourceIndex 
)

Shortcut buffer request constructor.

Parameters
mapTypeThe type of mapping required.
bufferSubResourceIndexThe index of the sub-resource to map.

◆ MapRequestDescriptor() [3/3]

nkGraphics::MapRequestDescriptor::MapRequestDescriptor ( MAP  mapType,
unsigned int  textureIndexInArray,
unsigned int  textureMipIndex 
)

Shortcut texture request constructor.

Parameters
mapTypeThe type of mapping required.
textureIndexInArrayThe index within the array of the texture to map.
textureMipIndexThe index of the mip to map.

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