1. Epic GamesDeveloper
  3. FImageOccupancyMap

FImageOccupancyMap

ImageOccupancyMap calculates and stores coverage information for a 2D image/texture, for example coverage derived from UV islands of a mesh, 2D polygons, etc.

API > API/Runtime > API/Runtime/GeometryCore > API/Runtime/GeometryCore/Image

References

   
Module GeometryCore
Header /Engine/Source/Runtime/GeometryCore/Public/Image/ImageOccupancyMap.h
Include #include "Image/ImageOccupancyMap.h"

Syntax

class FImageOccupancyMap

Remarks

ImageOccupancyMap calculates and stores coverage information for a 2D image/texture, for example coverage derived from UV islands of a mesh, 2D polygons, etc.

An optional set of gutter texels can be calculated, and correspondence between gutter texels and the nearest interior texel is stored.

In addition, a 2D coordinate (eg UV) and integer ID (eg Triangle ID) of each texel can be calculated/stored. This is not just a cache. For 'border' texels where the texel center is technically outside the mesh/polygon, but the texel rectangle may still overlap the shape, the nearest UV/Triangle is stored. This simplifies computing samples around the borders such that the shape is covered under linear interpolatione/etc.

TODO Some of the names in this class are misleading because the name mentions "Texel" but should actually say "Sample" this is because the class initially supported only one sample per texel but later multi-sampling was added

Variables

  Type Name Description
Public variable TArray64< TTuple< int64, int64 > > BorderTexels Set of Border Texels, Pair is , so Border can be filled by directly copying from source to target.
Public variable bool bParallel  
Public variable FImageDimensions Dimensions Image Dimensions
Public variable int32 GutterSize Width of the gutter.
Public variable TArray64< TTuple< int64, int64 > > GutterTexels Set of Gutter Texels.
Public variable FGridSampler PixelSampler  
Public variable TArray64< int32 > TexelInteriorSamples Count of interior samples for each texel in Tile. Size = Tile.GetWidth() x Tile.GetHeight().
Public variable TArray64< int32 > TexelQueryTriangle Integer/Triangle ID for each sample in Tile.
Public variable TArray64< FVector2f > TexelQueryUV UV for each sample in Tile. Size = Tile.GetWidth() x Tile.GetHeight() x SamplesPerPixel.
Public variable TArray64< int32 > TexelQueryUVChart UV Chart ID for each texel in Tile.
Public variable TArray64< int8 > TexelType Classification of each sample in Tile. Size = Tile.GetWidth() x Tile.GetHeight() x SamplesPerPixel.
Public variable FImageTile Tile  

Functions

  Type Name Description
Public function bool

ClassifySamplesFromUVSpaceMesh ( const MeshType& UVSpaceMesh,
GetTriangleIDFuncType GetTriangleIDFunc,
const TArray< int32 >* UVSpaceMeshTriCharts
)

 Void SetTexelType(int64 X, int64 Y, int8 Type)
Public function bool

ComputeFromUVSpaceMesh ( const MeshType& UVSpaceMesh,
GetTriangleIDFuncType GetTriangleIDFunc,
const TArray< int32 >* UVSpaceMeshTriCharts
)

 Computes the image occupancy map from a UV space mesh.
Public function bool  
Public function void

Initialize ( FImageDimensions DimensionsIn,
int32 SamplesPerPixel
)

  
Public function void

Initialize ( FImageDimensions DimensionsIn,
const FImageTile& TileIn,
int32 SamplesPerPixel
)

  
Protected function void

InitializePixelSampler ( const int32 SamplesPerPixelIn
)

 Initialize the pixel sampler.
Public function Const bool

IsInterior ( int64 LinearIndex
)

  
Public function Const void

ParallelProcessingPass ( TFunctionRef< TexelValueType(int64 LinearIdx)> BeginTexel,
TFunctionRef< void(int64 LinearIdx, float Weight, TexelValueType&)> AccumulateTexel,
TFunctionRef< void(int64 LinearIdx, float Weight, TexelValueType&)> CompleteTexel,
TFunctionRef< void(int64 LinearIdx, TexelValueType&)> WriteTexel,
TFunctionRef< float(const FVector2i&TexelOffset)> WeightFunction,
int32 FilterWidth,
TArray< TexelValueType >& PassBuffer
)

  
Public function Const int32

TexelNumSamples ( int64 LinearIndex
)

  

Typedefs

Name Description
FGridSampler  

Constants

Name Description
BorderTexel  
EmptyTexel Texel types
GutterTexel  
InteriorTexel  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page