Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
GeomVertexArrayData Class Reference

This is the data for one array of a GeomVertexData structure. More...

Inheritance diagram for GeomVertexArrayData:
CopyOnWriteObject SimpleLruPage GeomEnums CachedTypedWritableReferenceCount TypedWritableReferenceCount TypedWritable ReferenceCount TypedObject

Public Member Functions

int __getbuffer__ (PyBuffer view, int flags)
 
int __getbuffer__ (PyBuffer view, int flags)
 
 __init__ (const GeomVertexArrayData copy)
 
 __init__ (const GeomVertexArrayFormat array_format, GeomEnums::UsageHint usage_hint)
 
 __releasebuffer__ (PyBuffer view)
 
 clearRows ()
 Removes all of the rows in the array. More...
 
int compareTo (const GeomVertexArrayData other)
 Returns 0 if the two arrays are equivalent, even if they are not the same pointer. More...
 
const GeomVertexArrayFormat getArrayFormat ()
 Returns the format object that describes this array. More...
 
int getDataSizeBytes ()
 Returns the number of bytes stored in the array. More...
 
const GeomVertexArrayDataHandle getHandle (Thread current_thread)
 Returns an object that can be used to read the actual data bytes stored in the array. More...
 
UpdateSeq getModified ()
 Returns a sequence number which is guaranteed to change at least every time the array vertex data is modified. More...
 
int getNumRows ()
 Returns the number of rows stored in the array, based on the number of bytes and the stride. More...
 
GeomEnums::UsageHint getUsageHint ()
 Returns the usage hint that describes to the rendering backend how often the vertex data will be modified and/or rendered. More...
 
bool hasColumn (const InternalName name)
 Returns true if the array has the named column, false otherwise. More...
 
bool isPrepared (PreparedGraphicsObjects prepared_objects)
 Returns true if the data has already been prepared or enqueued for preparation on the indicated GSG, false otherwise. More...
 
GeomVertexArrayDataHandle modifyHandle (Thread current_thread)
 Returns an object that can be used to read or write the actual data bytes stored in the array. More...
 
 operator new (int size)
 
GeomVertexArrayData operator= (const GeomVertexArrayData copy)
 
 output (Ostream out)
 
 prepare (PreparedGraphicsObjects prepared_objects)
 Indicates that the data should be enqueued to be prepared in the indicated prepared_objects at the beginning of the next frame. More...
 
VertexBufferContext prepareNow (PreparedGraphicsObjects prepared_objects, GraphicsStateGuardianBase gsg)
 Creates a context for the data on the particular GSG, if it does not already exist. More...
 
bool release (PreparedGraphicsObjects prepared_objects)
 Frees the data context only on the indicated object, if it exists there. More...
 
int releaseAll ()
 Frees the context allocated on all objects for which the data has been declared. More...
 
bool requestResident (Thread current_thread)
 Returns true if the vertex data is currently resident in memory. More...
 
bool reserveNumRows (int n)
 This ensures that enough memory space for n rows is allocated, so that you may increase the number of rows to n without causing a new memory allocation. More...
 
bool setNumRows (int n)
 Sets the length of the array to n rows. More...
 
 setUsageHint (GeomEnums::UsageHint usage_hint)
 Changes the UsageHint hint for this array. More...
 
bool uncleanSetNumRows (int n)
 This method behaves like set_num_rows(), except the new data is not initialized. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from CopyOnWriteObject
 cacheRef ()
 
bool cacheUnref ()
 
- Public Member Functions inherited from CachedTypedWritableReferenceCount
 cacheRef ()
 Explicitly increments the cache reference count and the normal reference count simultaneously. More...
 
bool cacheUnref ()
 Explicitly decrements the cache reference count and the normal reference count simultaneously. More...
 
int getCacheRefCount ()
 Returns the current reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
VectorUchar encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encodeToBamStream (VectorUchar data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
 fillin (DatagramIterator scan, BamReader manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
bool unref ()
 Explicitly decrements the reference count. More...
 
- Public Member Functions inherited from SimpleLruPage
 __init__ (const SimpleLruPage copy)
 
 __init__ (int lru_size)
 
 dequeueLru ()
 Removes the page from its SimpleLru. More...
 
 enqueueLru (SimpleLru lru)
 Adds the page to the LRU for the first time, or marks it recently-accessed if it has already been added. More...
 
 evictLru ()
 Evicts the page from the LRU. More...
 
SimpleLru getLru ()
 Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU. More...
 
int getLruSize ()
 Returns the size of this page as reported to the LRU, presumably in bytes. More...
 
 markUsedLru ()
 To be called when the page is used; this will move it to the tail of the SimpleLru queue it is already on. More...
 
 markUsedLru (SimpleLru lru)
 To be called when the page is used; this will move it to the tail of the specified SimpleLru queue. More...
 
SimpleLruPage operator= (const SimpleLruPage copy)
 
 output (Ostream out)
 
 setLruSize (int lru_size)
 Specifies the size of this page, presumably in bytes, although any unit is possible. More...
 
 write (Ostream out, int indent_level)
 
- Public Member Functions inherited from GeomEnums
 __init__ ()
 
 __init__ (const GeomEnums)
 

Static Public Member Functions

static VertexDataBook getBook ()
 Returns the global VertexDataBook that will be used to allocate vertex data buffers. More...
 
static TypeHandle getClassType ()
 
static SimpleLru getIndependentLru ()
 Returns a pointer to the global LRU object that manages the GeomVertexArrayData's that have not (yet) been paged out. More...
 
static SimpleLru getSmallLru ()
 Returns a pointer to the global LRU object that manages the GeomVertexArrayData's that are deemed too small to be paged out. More...
 
static lruEpoch ()
 Marks that an epoch has passed in each LRU. More...
 
- Static Public Member Functions inherited from CopyOnWriteObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from CachedTypedWritableReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (VectorUchar data, BamReader reader)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on those bytes. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 

Public Attributes

const GeomVertexArrayFormat array_format
 Returns the format object that describes this array. More...
 
int data_size_bytes
 Returns the number of bytes stored in the array. More...
 
UpdateSeq modified
 Returns a sequence number which is guaranteed to change at least every time the array vertex data is modified. More...
 
GeomEnums::UsageHint usage_hint
 Returns the usage hint that describes to the rendering backend how often the vertex data will be modified and/or rendered. More...
 
- Public Attributes inherited from CachedTypedWritableReferenceCount
int cache_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from TypedObject
TypeHandle type
 Returns the TypeHandle representing this object's type. More...
 
- Public Attributes inherited from ReferenceCount
int ref_count
 The current reference count. More...
 

Additional Inherited Members

- Public Types inherited from GeomEnums
enum  AnimationType { AT_none = 0, AT_panda = 1, AT_hardware = 2 }
 
enum  Contents {
  C_other = 0, C_point = 1, C_clip_point = 2, C_vector = 3,
  C_texcoord = 4, C_color = 5, C_index = 6, C_morph_delta = 7,
  C_matrix = 8, C_normal = 9
}
 
enum  GeomRendering {
  GR_indexed_point = 1, GR_indexed_other = 65536, GR_indexed_bits = 65537, GR_point = 2,
  GR_point_uniform_size = 4, GR_per_point_size = 8, GR_point_perspective = 16, GR_point_aspect_ratio = 32,
  GR_point_scale = 64, GR_point_rotate = 128, GR_point_sprite = 256, GR_point_sprite_tex_matrix = 512,
  GR_point_bits = 1022, GR_triangle_strip = 1024, GR_triangle_fan = 2048, GR_line_strip = 4096,
  GR_composite_bits = 7168, GR_strip_cut_index = 131072, GR_flat_first_vertex = 8192, GR_flat_last_vertex = 16384,
  GR_shade_model_bits = 24576, GR_render_mode_wireframe = 262144, GR_render_mode_point = 524288, GR_adjacency = 1048576
}
 
enum  NumericType {
  NT_uint8 = 0, NT_uint16 = 1, NT_uint32 = 2, NT_packed_dcba = 3,
  NT_packed_dabc = 4, NT_float32 = 5, NT_float64 = 6, NT_stdfloat = 7,
  NT_int8 = 8, NT_int16 = 9, NT_int32 = 10, NT_packed_ufloat = 11
}
 
enum  PrimitiveType {
  PT_none = 0, PT_polygons = 1, PT_lines = 2, PT_points = 3,
  PT_patches = 4
}
 
enum  ShadeModel { SM_uniform = 0, SM_smooth = 1, SM_flat_first_vertex = 2, SM_flat_last_vertex = 3 }
 
enum  UsageHint {
  UH_client = 0, UH_stream = 1, UH_dynamic = 2, UH_static = 3,
  UH_unspecified = 4
}
 

Detailed Description

This is the data for one array of a GeomVertexData structure.

Many GeomVertexData structures will only define one array, with all data elements interleaved (DirectX 8.0 and before insisted on this format); some will define multiple arrays.

DirectX calls this concept of one array a "stream". It also closely correlates with the concept of a vertex buffer.

This object is just a block of data. In general, you should not be directly messing with this object from application code. See GeomVertexData for the organizing structure, and see GeomVertexReader/Writer/Rewriter for high-level tools to manipulate the actual vertex data.

Member Function Documentation

◆ __getbuffer__() [1/2]

int __getbuffer__ ( PyBuffer  view,
int  flags 
)

◆ __getbuffer__() [2/2]

int __getbuffer__ ( PyBuffer  view,
int  flags 
)

◆ __init__() [1/2]

__init__ ( const GeomVertexArrayData  copy)

◆ __init__() [2/2]

__init__ ( const GeomVertexArrayFormat  array_format,
GeomEnums::UsageHint  usage_hint 
)

◆ __releasebuffer__()

__releasebuffer__ ( PyBuffer  view)

◆ clearRows()

clearRows ( )

Removes all of the rows in the array.

Functionally equivalent to set_num_rows(0).

◆ compareTo()

int compareTo ( const GeomVertexArrayData  other)

Returns 0 if the two arrays are equivalent, even if they are not the same pointer.

◆ getArrayFormat()

const GeomVertexArrayFormat getArrayFormat ( )

Returns the format object that describes this array.

◆ getBook()

static VertexDataBook getBook ( )
static

Returns the global VertexDataBook that will be used to allocate vertex data buffers.

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ getDataSizeBytes()

int getDataSizeBytes ( )

Returns the number of bytes stored in the array.

◆ getHandle()

const GeomVertexArrayDataHandle getHandle ( Thread  current_thread)

Returns an object that can be used to read the actual data bytes stored in the array.

Calling this method locks the data, and will block any other threads attempting to read or write the data, until the returned object destructs.

◆ getIndependentLru()

static SimpleLru getIndependentLru ( )
static

Returns a pointer to the global LRU object that manages the GeomVertexArrayData's that have not (yet) been paged out.

◆ getModified()

UpdateSeq getModified ( )

Returns a sequence number which is guaranteed to change at least every time the array vertex data is modified.

◆ getNumRows()

int getNumRows ( )

Returns the number of rows stored in the array, based on the number of bytes and the stride.

This should be the same for all arrays within a given GeomVertexData object.

◆ getSmallLru()

static SimpleLru getSmallLru ( )
static

Returns a pointer to the global LRU object that manages the GeomVertexArrayData's that are deemed too small to be paged out.

◆ getUsageHint()

GeomEnums::UsageHint getUsageHint ( )

Returns the usage hint that describes to the rendering backend how often the vertex data will be modified and/or rendered.

See geomEnums.h.

◆ hasColumn()

bool hasColumn ( const InternalName  name)

Returns true if the array has the named column, false otherwise.

This is really just a shortcut for asking the same thing from the format.

◆ isPrepared()

bool isPrepared ( PreparedGraphicsObjects  prepared_objects)

Returns true if the data has already been prepared or enqueued for preparation on the indicated GSG, false otherwise.

◆ lruEpoch()

static lruEpoch ( )
static

Marks that an epoch has passed in each LRU.

Asks the LRU's to consider whether they should perform evictions.

◆ modifyHandle()

GeomVertexArrayDataHandle modifyHandle ( Thread  current_thread)

Returns an object that can be used to read or write the actual data bytes stored in the array.

Calling this method locks the data, and will block any other threads attempting to read or write the data, until the returned object destructs.

◆ operator new()

operator new ( int  size)

◆ operator=()

GeomVertexArrayData operator= ( const GeomVertexArrayData  copy)

◆ output()

output ( Ostream  out)

◆ prepare()

prepare ( PreparedGraphicsObjects  prepared_objects)

Indicates that the data should be enqueued to be prepared in the indicated prepared_objects at the beginning of the next frame.

This will ensure the data is already loaded into the GSG if it is expected to be rendered soon.

Use this function instead of prepare_now() to preload datas from a user interface standpoint.

◆ prepareNow()

VertexBufferContext prepareNow ( PreparedGraphicsObjects  prepared_objects,
GraphicsStateGuardianBase  gsg 
)

Creates a context for the data on the particular GSG, if it does not already exist.

Returns the new (or old) VertexBufferContext. This assumes that the GraphicsStateGuardian is the currently active rendering context and that it is ready to accept new datas. If this is not necessarily the case, you should use prepare() instead.

Normally, this is not called directly except by the GraphicsStateGuardian; a data does not need to be explicitly prepared by the user before it may be rendered.

◆ release()

bool release ( PreparedGraphicsObjects  prepared_objects)

Frees the data context only on the indicated object, if it exists there.

Returns true if it was released, false if it had not been prepared.

◆ releaseAll()

int releaseAll ( )

Frees the context allocated on all objects for which the data has been declared.

Returns the number of contexts which have been freed.

◆ requestResident()

bool requestResident ( Thread  current_thread)

Returns true if the vertex data is currently resident in memory.

If this returns true, the next call to get_handle()->get_read_pointer() will probably not block. If this returns false, the vertex data will be brought back into memory shortly; try again later.

◆ reserveNumRows()

bool reserveNumRows ( int  n)

This ensures that enough memory space for n rows is allocated, so that you may increase the number of rows to n without causing a new memory allocation.

This is a performance optimization only; it is especially useful when you know ahead of time that you will be adding n rows to the data.

◆ setNumRows()

bool setNumRows ( int  n)

Sets the length of the array to n rows.

Normally, you would not call this directly, since all of the arrays in a particular GeomVertexData must have the same number of rows; instead, call GeomVertexData::set_num_rows().

The return value is true if the number of rows was changed, false if the object already contained n rows (or if there was some error).

The new vertex data is initialized to 0, including the "color" column (but see GeomVertexData::set_num_rows()).

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ setUsageHint()

setUsageHint ( GeomEnums::UsageHint  usage_hint)

Changes the UsageHint hint for this array.

See get_usage_hint().

Don't call this in a downstream thread unless you don't mind it blowing away other changes you might have recently made in an upstream thread.

◆ uncleanSetNumRows()

bool uncleanSetNumRows ( int  n)

This method behaves like set_num_rows(), except the new data is not initialized.

Furthermore, after this call, any of the data in the GeomVertexArrayData may be uninitialized, including the earlier rows.

Normally, you would not call this directly, since all of the arrays in a particular GeomVertexData must have the same number of rows; instead, call GeomVertexData::unclean_set_num_rows().

◆ write()

write ( Ostream  out,
int  indent_level 
)

Member Data Documentation

◆ array_format

const GeomVertexArrayFormat array_format

Returns the format object that describes this array.

◆ data_size_bytes

int data_size_bytes

Returns the number of bytes stored in the array.

◆ modified

UpdateSeq modified

Returns a sequence number which is guaranteed to change at least every time the array vertex data is modified.

◆ usage_hint

Returns the usage hint that describes to the rendering backend how often the vertex data will be modified and/or rendered.

See geomEnums.h.