# GeomVertexArrayData

from pandac.PandaModules import GeomVertexArrayData

Class : GeomVertexArrayData
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.

## Inheritance:

GeomVertexArrayData: CopyOnWriteObject SimpleLruPage GeomEnums
CopyOnWriteObject: CachedTypedWritableReferenceCount
CachedTypedWritableReferenceCount: TypedWritableReferenceCount
TypedWritableReferenceCount: TypedWritable ReferenceCount
TypedWritable: TypedObject
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase
SimpleLruPage: LinkedListNode
LinkedListNode:
GeomEnums:

## Methods of GeomVertexArrayData:

clearRows
compareTo
getArrayFormat
getBook
getClassType
getDataSizeBytes
getHandle
getIndependentLru
getModified
getNumRows
getSmallLru
getUsageHint
hasColumn
isPrepared
lruEpoch
modifyHandle
operator =
operator delete
operator new
output
prepare
prepareNow
release
releaseAll
requestResident
setNumRows
setUsageHint
uncleanSetNumRows
validatePtr
write

## Methods of CopyOnWriteObject:

getClassType

## Methods of CachedTypedWritableReferenceCount:

cacheRef
cacheUnref
getCacheRefCount
getClassType
testRefCountIntegrity

## Methods of TypedWritableReferenceCount:

getClassType

## Methods of TypedWritable:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

## Methods of SimpleLruPage:

dequeueLru
enqueueLru
evictLru
getLru
getLruSize
markUsedLru
operator =
setLruSize

## Constants in GeomEnums:

UHClient | (UsageHint)
UHStream | (UsageHint)
UHDynamic | (UsageHint)
UHStatic | (UsageHint)
UHUnspecified | (UsageHint)
GRIndexedPoint | (GeomRendering)
GRIndexedOther | (GeomRendering)
GRIndexedBits | (GeomRendering)
GRPoint | (GeomRendering)
GRPointUniformSize | (GeomRendering)
GRPerPointSize | (GeomRendering)
GRPointPerspective | (GeomRendering)
GRPointAspectRatio | (GeomRendering)
GRPointScale | (GeomRendering)
GRPointRotate | (GeomRendering)
GRPointSprite | (GeomRendering)
GRPointSpriteTexMatrix | (GeomRendering)
GRPointBits | (GeomRendering)
GRTriangleStrip | (GeomRendering)
GRTriangleFan | (GeomRendering)
GRLineStrip | (GeomRendering)
GRCompositeBits | (GeomRendering)
GRFlatFirstVertex | (GeomRendering)
GRFlatLastVertex | (GeomRendering)
GRShadeModelBits | (GeomRendering)
GRTexcoordLightVector | (GeomRendering)
SMUniform | (ShadeModel)
SMSmooth | (ShadeModel)
SMFlatFirstVertex | (ShadeModel)
SMFlatLastVertex | (ShadeModel)
PTNone | (PrimitiveType)
PTPolygons | (PrimitiveType)
PTLines | (PrimitiveType)
PTPoints | (PrimitiveType)
NTUint8 | (NumericType)
NTUint16 | (NumericType)
NTUint32 | (NumericType)
NTPackedDcba | (NumericType)
NTPackedDabc | (NumericType)
NTFloat32 | (NumericType)
COther | (Contents)
CPoint | (Contents)
CClipPoint | (Contents)
CVector | (Contents)
CTexcoord | (Contents)
CColor | (Contents)
CIndex | (Contents)
CMorphDelta | (Contents)
ATNone | (AnimationType)
ATPanda | (AnimationType)
ATHardware | (AnimationType)

clearRows void GeomVertexArrayData::clear_rows(void); Description: Removes all of the rows in the array. Functionally equivalent to set_num_rows(0).

compareTo int GeomVertexArrayData::compare_to(GeomVertexArrayData const &other) const; Description: Returns 0 if the two arrays are equivalent, even if they are not the same pointer.

getArrayFormat GeomVertexArrayFormat const *GeomVertexArrayData::get_array_format(void) const; Filename: geomVertexArrayData.I Created by: drose (17Mar05) PANDA 3D SOFTWARE Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved All use of this software is subject to the terms of the Panda 3d Software license. You should have received a copy of this license along with this source code; you will also find a current copy of the license at http://etc.cmu.edu/panda3d/docs/license/ . To contact the maintainers of this program write to panda3d-general@lists.sourceforge.net . Description: Returns the format object that describes this array.

getBook static VertexDataBook &GeomVertexArrayData::get_book(void); Description: Returns the global VertexDataBook that will be used to allocate vertex data buffers.

getClassType static TypeHandle GeomVertexArrayData::get_class_type(void); Undocumented function.

getDataSizeBytes int GeomVertexArrayData::get_data_size_bytes(void) const; Description: Returns the number of bytes stored in the array.

getHandle ConstPointerTo< GeomVertexArrayDataHandle > GeomVertexArrayData::get_handle(Thread *current_thread = ((get_current_thread()))) const; Description: 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 *GeomVertexArrayData::get_independent_lru(void); Description: Returns a pointer to the global LRU object that manages the GeomVertexArrayData's that have not (yet) been paged out.

getModified UpdateSeq GeomVertexArrayData::get_modified(void) const; Description: Returns a sequence number which is guaranteed to change at least every time the array vertex data is modified.

getNumRows int GeomVertexArrayData::get_num_rows(void) const; Description: 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 *GeomVertexArrayData::get_small_lru(void); Description: 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 GeomVertexArrayData::get_usage_hint(void) const; Description: 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 GeomVertexArrayData::has_column(InternalName const *name) const; Description: 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 GeomVertexArrayData::is_prepared(PreparedGraphicsObjects *prepared_objects) const; Description: Returns true if the data has already been prepared or enqueued for preparation on the indicated GSG, false otherwise.

lruEpoch static void GeomVertexArrayData::lru_epoch(void); Description: Marks that an epoch has passed in each LRU. Asks the LRU's to consider whether they should perform evictions.

modifyHandle PointerTo< GeomVertexArrayDataHandle > GeomVertexArrayData::modify_handle(Thread *current_thread = ((get_current_thread()))); Description: 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 = void GeomVertexArrayData::operator =(GeomVertexArrayData const &copy); Description: The copy assignment operator is not pipeline-safe. This will completely obliterate all stages of the pipeline, so don't do it for a GeomVertexArrayData that is actively being used for rendering.

operator delete void GeomVertexArrayData::operator delete(void *ptr); Undocumented function.

operator new void *GeomVertexArrayData::operator new(unsigned int size); Undocumented function.

output void GeomVertexArrayData::output(ostream &out) const; Description:

prepare void GeomVertexArrayData::prepare(PreparedGraphicsObjects *prepared_objects); Description: 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 *GeomVertexArrayData::prepare_now(PreparedGraphicsObjects *prepared_objects, GraphicsStateGuardianBase *gsg); Description: 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 GeomVertexArrayData::release(PreparedGraphicsObjects *prepared_objects); Description: 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 GeomVertexArrayData::release_all(void); Description: 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 GeomVertexArrayData::request_resident(void) const; Description: 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.

setNumRows bool GeomVertexArrayData::set_num_rows(int n); Description: 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 void GeomVertexArrayData::set_usage_hint(GeomEnums::UsageHint usage_hint); Description: 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 GeomVertexArrayData::unclean_set_num_rows(int n); Description: 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().

validatePtr static bool GeomVertexArrayData::validate_ptr(void const *ptr); Undocumented function.

write void GeomVertexArrayData::write(ostream &out, int indent_level = (0)) const; Description:

getClassType static TypeHandle CopyOnWriteObject::get_class_type(void); Undocumented function.

cacheRef void CachedTypedWritableReferenceCount::cache_ref(void) const; Description: Explicitly increments the cache reference count and the normal reference count simultaneously.

cacheUnref bool CachedTypedWritableReferenceCount::cache_unref(void) const; Description: Explicitly decrements the cache reference count and the normal reference count simultaneously. The return value is true if the new reference count is nonzero, false if it is zero.

getCacheRefCount int CachedTypedWritableReferenceCount::get_cache_ref_count(void) const; Description: Returns the current reference count.

getClassType static TypeHandle CachedTypedWritableReferenceCount::get_class_type(void); Undocumented function.

testRefCountIntegrity bool CachedTypedWritableReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus.

getClassType static TypeHandle TypedWritableReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedWritable::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete(). User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it. The return value is true if the new reference count is nonzero, false if it is zero.

dequeueLru void SimpleLruPage::dequeue_lru(void); Description: Removes the page from its SimpleLru.

enqueueLru void SimpleLruPage::enqueue_lru(SimpleLru *lru); Description: Adds the page to the tail of the SimpleLru. When it reaches the head, it will be the next to be evicted.

evictLru virtual void SimpleLruPage::evict_lru(void); Description: Evicts the page from the LRU. Called internally when the LRU determines that it is full. May also be called externally when necessary to explicitly evict the page. It is legal for this method to either evict the page as requested, do nothing (in which case the eviction will be requested again at the next epoch), or requeue itself on the tail of the queue (in which case the eviction will be requested again much later).

getLru SimpleLru *SimpleLruPage::get_lru(void) const; Description: Returns the LRU that manages this page, or NULL if it is not currently managed by any LRU.

getLruSize unsigned int SimpleLruPage::get_lru_size(void) const; Description: Returns the size of this page as reported to the LRU, presumably in bytes.

markUsedLru void SimpleLruPage::mark_used_lru(void) const; Description: To be called when the page is used; this will move it to the tail of the SimpleLru queue it is already on. This method is const because it's not technically modifying the contents of the page itself. Description: To be called when the page is used; this will move it to the tail of the specified SimpleLru queue.

operator = void SimpleLruPage::operator =(SimpleLruPage const &copy); Description:

setLruSize void SimpleLruPage::set_lru_size(unsigned int lru_size); Description: Specifies the size of this page, presumably in bytes, although any unit is possible.